From b356460511d5eb5718d1bf038b1b337771431a34 Mon Sep 17 00:00:00 2001 From: Erwin van Hunen Date: Fri, 31 Jan 2020 16:11:35 +0100 Subject: [PATCH] JAN 2020 Update --- .../sharepoint-pnp/sharepoint-pnp-cmdlets.md | 948 +++++++++--------- .../sharepoint-pnp/Add-PnPAlert.md | 4 +- .../sharepoint-pnp/Add-PnPApp.md | 4 +- .../Add-PnPApplicationCustomizer.md | 169 ++++ .../sharepoint-pnp/Add-PnPClientSidePage.md | 11 +- .../Add-PnPClientSidePageSection.md | 4 +- .../sharepoint-pnp/Add-PnPClientSideText.md | 4 +- .../Add-PnPClientSideWebPart.md | 24 +- .../sharepoint-pnp/Add-PnPContentType.md | 4 +- .../Add-PnPContentTypeToDocumentSet.md | 4 +- .../Add-PnPContentTypeToList.md | 4 +- .../sharepoint-pnp/Add-PnPCustomAction.md | 24 +- .../Add-PnPDataRowsToProvisioningTemplate.md | 8 +- .../sharepoint-pnp/Add-PnPDocumentSet.md | 4 +- .../sharepoint-pnp/Add-PnPEventReceiver.md | 4 +- .../sharepoint-pnp/Add-PnPField.md | 4 +- .../sharepoint-pnp/Add-PnPFieldFromXml.md | 4 +- .../Add-PnPFieldToContentType.md | 4 +- .../sharepoint-pnp/Add-PnPFile.md | 8 +- .../Add-PnPFileToProvisioningTemplate.md | 4 +- .../sharepoint-pnp/Add-PnPFolder.md | 4 +- .../Add-PnPHtmlPublishingPageLayout.md | 4 +- .../Add-PnPHubSiteAssociation.md | 4 +- .../sharepoint-pnp/Add-PnPIndexedProperty.md | 4 +- .../sharepoint-pnp/Add-PnPJavaScriptBlock.md | 4 +- .../sharepoint-pnp/Add-PnPJavaScriptLink.md | 6 +- ...dd-PnPListFoldersToProvisioningTemplate.md | 4 +- .../sharepoint-pnp/Add-PnPListItem.md | 26 +- .../sharepoint-pnp/Add-PnPMasterPage.md | 4 +- .../sharepoint-pnp/Add-PnPNavigationNode.md | 4 +- .../Add-PnPOffice365GroupToSite.md | 4 +- .../sharepoint-pnp/Add-PnPOrgAssetsLibrary.md | 100 ++ .../sharepoint-pnp/Add-PnPOrgNewsSite.md | 57 ++ .../Add-PnPProvisioningTemplate.md | 6 +- .../Add-PnPPublishingImageRendition.md | 4 +- .../sharepoint-pnp/Add-PnPPublishingPage.md | 4 +- .../Add-PnPPublishingPageLayout.md | 4 +- .../sharepoint-pnp/Add-PnPRoleDefinition.md | 10 +- .../Add-PnPSiteClassification.md | 4 +- .../Add-PnPSiteCollectionAdmin.md | 4 +- .../Add-PnPSiteCollectionAppCatalog.md | 4 +- .../sharepoint-pnp/Add-PnPSiteDesign.md | 4 +- .../sharepoint-pnp/Add-PnPSiteDesignTask.md | 4 +- .../sharepoint-pnp/Add-PnPSiteScript.md | 4 +- .../sharepoint-pnp/Add-PnPStoredCredential.md | 6 +- .../sharepoint-pnp/Add-PnPTaxonomyField.md | 4 +- .../sharepoint-pnp/Add-PnPTeamsTeam.md | 47 + .../sharepoint-pnp/Add-PnPTenantCdnOrigin.md | 4 +- .../sharepoint-pnp/Add-PnPTenantSequence.md | 9 +- .../Add-PnPTenantSequenceSite.md | 6 +- .../Add-PnPTenantSequenceSubSite.md | 4 +- .../sharepoint-pnp/Add-PnPTenantTheme.md | 4 +- .../sharepoint-pnp/Add-PnPUserToGroup.md | 4 +- .../sharepoint-pnp/Add-PnPView.md | 26 +- .../Add-PnPWebPartToWebPartPage.md | 8 +- .../Add-PnPWebPartToWikiPage.md | 4 +- .../Add-PnPWebhookSubscription.md | 4 +- .../sharepoint-pnp/Add-PnPWikiPage.md | 4 +- .../Add-PnPWorkflowDefinition.md | 4 +- .../Add-PnPWorkflowSubscription.md | 4 +- .../Apply-PnPProvisioningTemplate.md | 25 +- .../sharepoint-pnp/Apply-PnPTenantTemplate.md | 23 +- ...TenantServicePrincipalPermissionRequest.md | 4 +- .../Clear-PnPDefaultColumnValues.md | 4 +- .../Clear-PnPListItemAsRecord.md | 4 +- .../Clear-PnPTenantRecycleBinItem.md | 4 +- .../sharepoint-pnp/Clear-PnpRecycleBinItem.md | 4 +- .../sharepoint-pnp/Connect-PnPOnline.md | 208 +++- ...Convert-PnPFolderToProvisioningTemplate.md | 4 +- .../Convert-PnPProvisioningTemplate.md | 4 +- .../ConvertTo-PnPClientSidePage.md | 234 ++++- .../sharepoint-pnp/Copy-PnPFile.md | 6 +- .../sharepoint-pnp/Copy-PnPItemProxy.md | 2 +- ...TenantServicePrincipalPermissionRequest.md | 4 +- .../sharepoint-pnp/Disable-PnPFeature.md | 4 +- ...able-PnPInPlaceRecordsManagementForSite.md | 4 +- .../Disable-PnPPowerShellTelemetry.md | 4 +- .../sharepoint-pnp/Disable-PnPResponsiveUI.md | 4 +- .../Disable-PnPSiteClassification.md | 2 +- .../Disable-PnPTenantServicePrincipal.md | 4 +- .../sharepoint-pnp/Disconnect-PnPOnline.md | 4 +- .../sharepoint-pnp/Enable-PnPCommSite.md | 4 +- .../sharepoint-pnp/Enable-PnPFeature.md | 4 +- ...able-PnPInPlaceRecordsManagementForSite.md | 4 +- .../Enable-PnPPowerShellTelemetry.md | 4 +- .../sharepoint-pnp/Enable-PnPResponsiveUI.md | 4 +- .../Enable-PnPSiteClassification.md | 4 +- .../Enable-PnPTenantServicePrincipal.md | 4 +- .../Export-PnPClientSidePage.md | 19 +- .../Export-PnPClientSidePageMapping.md | 17 +- .../Export-PnPListToProvisioningTemplate.md | 129 +++ .../sharepoint-pnp/Export-PnPTaxonomy.md | 8 +- .../Export-PnPTermGroupToXml.md | 4 +- .../sharepoint-pnp/Find-PnPFile.md | 4 +- .../sharepoint-pnp/Get-PnPAccessToken.md | 4 +- .../sharepoint-pnp/Get-PnPAlert.md | 4 +- .../sharepoint-pnp/Get-PnPApp.md | 4 +- .../Get-PnPAppAuthAccessToken.md | 4 +- .../sharepoint-pnp/Get-PnPAppInstance.md | 5 +- .../Get-PnPApplicationCustomizer.md | 170 ++++ .../sharepoint-pnp/Get-PnPAuditing.md | 4 +- .../Get-PnPAuthenticationRealm.md | 4 +- .../Get-PnPAvailableClientSideComponents.md | 4 +- .../sharepoint-pnp/Get-PnPAzureCertificate.md | 4 +- .../Get-PnPClientSideComponent.md | 4 +- .../sharepoint-pnp/Get-PnPClientSidePage.md | 11 +- .../sharepoint-pnp/Get-PnPConnection.md | 2 +- .../sharepoint-pnp/Get-PnPContentType.md | 6 +- .../Get-PnPContentTypePublishingHubUrl.md | 4 +- .../sharepoint-pnp/Get-PnPContext.md | 15 +- .../sharepoint-pnp/Get-PnPCustomAction.md | 5 +- .../Get-PnPDefaultColumnValues.md | 4 +- .../Get-PnPDeletedUnifiedGroup.md | 51 + .../Get-PnPDocumentSetTemplate.md | 5 +- .../sharepoint-pnp/Get-PnPEventReceiver.md | 4 +- .../sharepoint-pnp/Get-PnPException.md | 4 +- .../sharepoint-pnp/Get-PnPFeature.md | 5 +- .../sharepoint-pnp/Get-PnPField.md | 5 +- .../sharepoint-pnp/Get-PnPFile.md | 4 +- .../sharepoint-pnp/Get-PnPFolder.md | 43 +- .../sharepoint-pnp/Get-PnPFolderItem.md | 51 +- .../sharepoint-pnp/Get-PnPGroup.md | 4 +- .../sharepoint-pnp/Get-PnPGroupMembers.md | 4 +- .../sharepoint-pnp/Get-PnPGroupPermissions.md | 4 +- .../sharepoint-pnp/Get-PnPHealthScore.md | 4 +- .../Get-PnPHideDefaultThemes.md | 4 +- .../sharepoint-pnp/Get-PnPHomePage.md | 4 +- .../sharepoint-pnp/Get-PnPHomeSite.md | 4 +- .../sharepoint-pnp/Get-PnPHubSite.md | 4 +- .../sharepoint-pnp/Get-PnPHubSiteChild.md | 47 + .../Get-PnPInPlaceRecordsManagement.md | 4 +- .../Get-PnPIndexedPropertyKeys.md | 4 +- .../sharepoint-pnp/Get-PnPJavaScriptLink.md | 4 +- .../sharepoint-pnp/Get-PnPLabel.md | 8 +- .../sharepoint-pnp/Get-PnPList.md | 5 +- .../Get-PnPListInformationRightsManagement.md | 4 +- .../sharepoint-pnp/Get-PnPListItem.md | 4 +- .../Get-PnPListRecordDeclaration.md | 4 +- .../Get-PnPManagementApiAccessToken.md | 77 ++ .../sharepoint-pnp/Get-PnPMasterPage.md | 4 +- .../sharepoint-pnp/Get-PnPNavigationNode.md | 4 +- .../sharepoint-pnp/Get-PnPOrgAssetsLibrary.md | 51 + .../sharepoint-pnp/Get-PnPOrgNewsSite.md | 44 + .../Get-PnPPowerShellTelemetryEnabled.md | 4 +- .../sharepoint-pnp/Get-PnPProperty.md | 4 +- .../sharepoint-pnp/Get-PnPPropertyBag.md | 4 +- .../Get-PnPProvisioningTemplate.md | 17 +- .../Get-PnPPublishingImageRendition.md | 4 +- .../sharepoint-pnp/Get-PnPRecycleBinItem.md | 33 +- .../Get-PnPRequestAccessEmails.md | 4 +- .../sharepoint-pnp/Get-PnPRoleDefinition.md | 4 +- .../Get-PnPSearchConfiguration.md | 4 +- .../sharepoint-pnp/Get-PnPSearchCrawlLog.md | 32 +- .../sharepoint-pnp/Get-PnPSearchSettings.md | 57 ++ .../sharepoint-pnp/Get-PnPSite.md | 5 +- .../Get-PnPSiteClassification.md | 2 +- .../sharepoint-pnp/Get-PnPSiteClosure.md | 4 +- .../Get-PnPSiteCollectionAdmin.md | 4 +- .../Get-PnPSiteCollectionTermStore.md | 4 +- .../sharepoint-pnp/Get-PnPSiteDesign.md | 4 +- .../sharepoint-pnp/Get-PnPSiteDesignRights.md | 4 +- .../sharepoint-pnp/Get-PnPSiteDesignRun.md | 4 +- .../Get-PnPSiteDesignRunStatus.md | 6 +- .../sharepoint-pnp/Get-PnPSiteDesignTask.md | 6 +- .../sharepoint-pnp/Get-PnPSitePolicy.md | 4 +- .../sharepoint-pnp/Get-PnPSiteScript.md | 4 +- .../Get-PnPSiteSearchQueryResults.md | 4 +- .../sharepoint-pnp/Get-PnPStorageEntity.md | 4 +- .../sharepoint-pnp/Get-PnPStoredCredential.md | 4 +- .../sharepoint-pnp/Get-PnPSubWebs.md | 5 +- .../sharepoint-pnp/Get-PnPTaxonomyItem.md | 4 +- .../sharepoint-pnp/Get-PnPTaxonomySession.md | 4 +- .../sharepoint-pnp/Get-PnPTenant.md | 4 +- .../Get-PnPTenantAppCatalogUrl.md | 4 +- .../sharepoint-pnp/Get-PnPTenantCdnEnabled.md | 4 +- .../sharepoint-pnp/Get-PnPTenantCdnOrigin.md | 4 +- .../Get-PnPTenantCdnPolicies.md | 4 +- .../sharepoint-pnp/Get-PnPTenantId.md | 51 + .../Get-PnPTenantRecycleBinItem.md | 4 +- .../sharepoint-pnp/Get-PnPTenantSequence.md | 10 +- .../Get-PnPTenantSequenceSite.md | 4 +- .../Get-PnPTenantServicePrincipal.md | 4 +- ...PTenantServicePrincipalPermissionGrants.md | 4 +- ...enantServicePrincipalPermissionRequests.md | 4 +- .../sharepoint-pnp/Get-PnPTenantSite.md | 6 +- .../sharepoint-pnp/Get-PnPTenantTemplate.md | 129 +++ .../sharepoint-pnp/Get-PnPTenantTheme.md | 4 +- .../sharepoint-pnp/Get-PnPTerm.md | 4 +- .../sharepoint-pnp/Get-PnPTermGroup.md | 5 +- .../sharepoint-pnp/Get-PnPTermSet.md | 5 +- .../sharepoint-pnp/Get-PnPTheme.md | 4 +- .../sharepoint-pnp/Get-PnPTimeZoneId.md | 4 +- .../Get-PnPUPABulkImportStatus.md | 4 +- .../sharepoint-pnp/Get-PnPUnifiedAuditLog.md | 71 ++ .../sharepoint-pnp/Get-PnPUnifiedGroup.md | 6 +- .../Get-PnPUnifiedGroupMembers.md | 8 +- .../Get-PnPUnifiedGroupOwners.md | 8 +- .../sharepoint-pnp/Get-PnPUser.md | 8 +- .../Get-PnPUserProfileProperty.md | 6 +- .../sharepoint-pnp/Get-PnPView.md | 5 +- .../sharepoint-pnp/Get-PnPWeb.md | 5 +- .../sharepoint-pnp/Get-PnPWebPart.md | 4 +- .../sharepoint-pnp/Get-PnPWebPartProperty.md | 4 +- .../sharepoint-pnp/Get-PnPWebPartXml.md | 4 +- .../sharepoint-pnp/Get-PnPWebTemplates.md | 4 +- .../Get-PnPWebhookSubscriptions.md | 4 +- .../sharepoint-pnp/Get-PnPWikiPageContent.md | 4 +- .../Get-PnPWorkflowDefinition.md | 4 +- .../sharepoint-pnp/Get-PnPWorkflowInstance.md | 4 +- .../Get-PnPWorkflowSubscription.md | 4 +- .../sharepoint-pnp/Grant-PnPHubSiteRights.md | 4 +- .../Grant-PnPSiteDesignRights.md | 4 +- ...ant-PnPTenantServicePrincipalPermission.md | 4 +- .../sharepoint-pnp/Import-PnPAppPackage.md | 8 +- .../sharepoint-pnp/Import-PnPTaxonomy.md | 4 +- .../Import-PnPTermGroupFromXml.md | 4 +- .../sharepoint-pnp/Import-PnPTermSet.md | 8 +- .../sharepoint-pnp/Install-PnPApp.md | 8 +- .../sharepoint-pnp/Install-PnPSolution.md | 4 +- .../sharepoint-pnp/Invoke-PnPQuery.md | 4 +- .../sharepoint-pnp/Invoke-PnPSPRestMethod.md | 4 +- .../sharepoint-pnp/Invoke-PnPSiteDesign.md | 4 +- .../sharepoint-pnp/Invoke-PnPWebAction.md | 4 +- .../sharepoint-pnp/Measure-PnPList.md | 5 +- .../sharepoint-pnp/Measure-PnPResponseTime.md | 4 +- .../sharepoint-pnp/Measure-PnPWeb.md | 4 +- .../Move-PnPClientSideComponent.md | 4 +- .../sharepoint-pnp/Move-PnPFile.md | 4 +- .../sharepoint-pnp/Move-PnPFolder.md | 4 +- .../sharepoint-pnp/Move-PnPItemProxy.md | 2 +- .../Move-PnPListItemToRecycleBin.md | 4 +- .../sharepoint-pnp/Move-PnpRecycleBinItem.md | 4 +- .../sharepoint-pnp/New-PnPAzureCertificate.md | 6 +- .../New-PnPExtensibilityHandlerObject.md | 6 +- .../sharepoint-pnp/New-PnPGroup.md | 4 +- .../sharepoint-pnp/New-PnPList.md | 4 +- .../sharepoint-pnp/New-PnPPersonalSite.md | 4 +- .../New-PnPProvisioningTemplate.md | 2 +- .../New-PnPProvisioningTemplateFromFolder.md | 4 +- .../sharepoint-pnp/New-PnPSite.md | 37 +- .../sharepoint-pnp/New-PnPTenantSequence.md | 4 +- .../New-PnPTenantSequenceCommunicationSite.md | 4 +- .../New-PnPTenantSequenceTeamNoGroupSite.md | 4 +- ...New-PnPTenantSequenceTeamNoGroupSubSite.md | 4 +- .../New-PnPTenantSequenceTeamSite.md | 4 +- .../sharepoint-pnp/New-PnPTenantSite.md | 10 +- .../sharepoint-pnp/New-PnPTenantTemplate.md | 4 +- .../sharepoint-pnp/New-PnPTerm.md | 15 +- .../sharepoint-pnp/New-PnPTermGroup.md | 4 +- .../sharepoint-pnp/New-PnPTermSet.md | 4 +- .../sharepoint-pnp/New-PnPUPABulkImportJob.md | 8 +- .../sharepoint-pnp/New-PnPUnifiedGroup.md | 6 +- .../sharepoint-pnp/New-PnPUser.md | 4 +- .../sharepoint-pnp/New-PnPWeb.md | 4 +- .../sharepoint-pnp/Publish-PnPApp.md | 4 +- .../Read-PnPProvisioningTemplate.md | 4 +- .../sharepoint-pnp/Read-PnPTenantTemplate.md | 4 +- .../sharepoint-pnp/Register-PnPHubSite.md | 4 +- .../sharepoint-pnp/Remove-PnPAlert.md | 4 +- .../sharepoint-pnp/Remove-PnPApp.md | 4 +- .../Remove-PnPApplicationCustomizer.md | 140 +++ .../Remove-PnPClientSideComponent.md | 4 +- .../Remove-PnPClientSidePage.md | 4 +- .../sharepoint-pnp/Remove-PnPContentType.md | 4 +- .../Remove-PnPContentTypeFromDocumentSet.md | 4 +- .../Remove-PnPContentTypeFromList.md | 4 +- .../sharepoint-pnp/Remove-PnPCustomAction.md | 4 +- .../Remove-PnPDeletedUnifiedGroup.md | 52 + .../sharepoint-pnp/Remove-PnPEventReceiver.md | 4 +- .../sharepoint-pnp/Remove-PnPField.md | 4 +- .../Remove-PnPFieldFromContentType.md | 4 +- .../sharepoint-pnp/Remove-PnPFile.md | 4 +- .../Remove-PnPFileFromProvisioningTemplate.md | 4 +- .../sharepoint-pnp/Remove-PnPFolder.md | 4 +- .../sharepoint-pnp/Remove-PnPGroup.md | 4 +- .../sharepoint-pnp/Remove-PnPHomeSite.md | 4 +- .../Remove-PnPHubSiteAssociation.md | 4 +- .../Remove-PnPIndexedProperty.md | 4 +- .../Remove-PnPJavaScriptLink.md | 4 +- .../sharepoint-pnp/Remove-PnPList.md | 4 +- .../sharepoint-pnp/Remove-PnPListItem.md | 4 +- .../Remove-PnPNavigationNode.md | 4 +- .../Remove-PnPOrgAssetsLibrary.md | 100 ++ .../sharepoint-pnp/Remove-PnPOrgNewsSite.md | 60 ++ .../Remove-PnPPropertyBagValue.md | 4 +- .../Remove-PnPPublishingImageRendition.md | 4 +- .../Remove-PnPRoleDefinition.md | 4 +- .../Remove-PnPSearchConfiguration.md | 4 +- .../Remove-PnPSiteClassification.md | 4 +- .../Remove-PnPSiteCollectionAdmin.md | 4 +- .../Remove-PnPSiteCollectionAppCatalog.md | 6 +- .../sharepoint-pnp/Remove-PnPSiteDesign.md | 4 +- .../Remove-PnPSiteDesignTask.md | 4 +- .../sharepoint-pnp/Remove-PnPSiteScript.md | 4 +- .../sharepoint-pnp/Remove-PnPStorageEntity.md | 6 +- .../Remove-PnPStoredCredential.md | 4 +- .../sharepoint-pnp/Remove-PnPTaxonomyItem.md | 4 +- .../Remove-PnPTenantCdnOrigin.md | 4 +- .../sharepoint-pnp/Remove-PnPTenantSite.md | 4 +- .../sharepoint-pnp/Remove-PnPTenantTheme.md | 4 +- .../sharepoint-pnp/Remove-PnPTermGroup.md | 4 +- .../sharepoint-pnp/Remove-PnPUnifiedGroup.md | 6 +- .../sharepoint-pnp/Remove-PnPUser.md | 4 +- .../sharepoint-pnp/Remove-PnPUserFromGroup.md | 4 +- .../sharepoint-pnp/Remove-PnPView.md | 4 +- .../sharepoint-pnp/Remove-PnPWeb.md | 4 +- .../sharepoint-pnp/Remove-PnPWebPart.md | 4 +- .../Remove-PnPWebhookSubscription.md | 4 +- .../sharepoint-pnp/Remove-PnPWikiPage.md | 4 +- .../Remove-PnPWorkflowDefinition.md | 4 +- .../Remove-PnPWorkflowSubscription.md | 4 +- .../sharepoint-pnp/Rename-PnPFile.md | 4 +- .../sharepoint-pnp/Rename-PnPFolder.md | 4 +- .../sharepoint-pnp/Request-PnPAccessToken.md | 168 ++++ .../sharepoint-pnp/Request-PnPReIndexList.md | 4 +- .../sharepoint-pnp/Request-PnPReIndexWeb.md | 4 +- .../sharepoint-pnp/Reset-PnPFileVersion.md | 4 +- .../sharepoint-pnp/Reset-PnPLabel.md | 90 ++ .../sharepoint-pnp/Resolve-PnPFolder.md | 5 +- .../Restore-PnPDeletedUnifiedGroup.md | 52 + .../Restore-PnPTenantRecycleBinItem.md | 10 +- .../Restore-PnpRecycleBinItem.md | 6 +- .../Resume-PnPWorkflowInstance.md | 4 +- .../Revoke-PnPSiteDesignRights.md | 4 +- ...oke-PnPTenantServicePrincipalPermission.md | 4 +- .../Save-PnPClientSidePageConversionLog.md | 4 +- .../Save-PnPProvisioningTemplate.md | 23 +- .../sharepoint-pnp/Save-PnPTenantTemplate.md | 7 +- .../sharepoint-pnp/Send-PnPMail.md | 4 +- .../sharepoint-pnp/Set-PnPAppSideLoading.md | 4 +- .../Set-PnPApplicationCustomizer.md | 188 ++++ .../sharepoint-pnp/Set-PnPAuditing.md | 4 +- .../Set-PnPAvailablePageLayouts.md | 4 +- .../sharepoint-pnp/Set-PnPClientSidePage.md | 19 +- .../sharepoint-pnp/Set-PnPClientSideText.md | 4 +- .../Set-PnPClientSideWebPart.md | 4 +- .../sharepoint-pnp/Set-PnPContext.md | 4 +- .../Set-PnPDefaultColumnValues.md | 4 +- .../Set-PnPDefaultContentTypeToList.md | 4 +- .../Set-PnPDefaultPageLayout.md | 4 +- .../sharepoint-pnp/Set-PnPDocumentSetField.md | 4 +- .../sharepoint-pnp/Set-PnPField.md | 4 +- .../sharepoint-pnp/Set-PnPFileCheckedIn.md | 4 +- .../sharepoint-pnp/Set-PnPFileCheckedOut.md | 4 +- .../sharepoint-pnp/Set-PnPFolderPermission.md | 219 ++++ .../sharepoint-pnp/Set-PnPGroup.md | 4 +- .../sharepoint-pnp/Set-PnPGroupPermissions.md | 4 +- .../Set-PnPHideDefaultThemes.md | 4 +- .../sharepoint-pnp/Set-PnPHomePage.md | 4 +- .../sharepoint-pnp/Set-PnPHomeSite.md | 4 +- .../sharepoint-pnp/Set-PnPHubSite.md | 60 +- .../Set-PnPInPlaceRecordsManagement.md | 4 +- .../Set-PnPIndexedProperties.md | 4 +- .../sharepoint-pnp/Set-PnPLabel.md | 10 +- .../sharepoint-pnp/Set-PnPList.md | 17 +- .../Set-PnPListInformationRightsManagement.md | 4 +- .../sharepoint-pnp/Set-PnPListItem.md | 26 +- .../sharepoint-pnp/Set-PnPListItemAsRecord.md | 4 +- .../Set-PnPListItemPermission.md | 6 +- .../sharepoint-pnp/Set-PnPListPermission.md | 4 +- .../Set-PnPListRecordDeclaration.md | 4 +- .../sharepoint-pnp/Set-PnPMasterPage.md | 4 +- .../Set-PnPMinimalDownloadStrategy.md | 4 +- .../sharepoint-pnp/Set-PnPPropertyBagValue.md | 6 +- .../Set-PnPProvisioningTemplateMetadata.md | 4 +- .../Set-PnPRequestAccessEmails.md | 6 +- .../Set-PnPSearchConfiguration.md | 4 +- .../sharepoint-pnp/Set-PnPSearchSettings.md | 164 +++ .../sharepoint-pnp/Set-PnPSite.md | 4 +- .../sharepoint-pnp/Set-PnPSiteClosure.md | 4 +- .../sharepoint-pnp/Set-PnPSiteDesign.md | 4 +- .../sharepoint-pnp/Set-PnPSitePolicy.md | 4 +- .../sharepoint-pnp/Set-PnPSiteScript.md | 6 +- .../sharepoint-pnp/Set-PnPStorageEntity.md | 4 +- .../Set-PnPTaxonomyFieldValue.md | 4 +- .../sharepoint-pnp/Set-PnPTenant.md | 27 +- .../sharepoint-pnp/Set-PnPTenantCdnEnabled.md | 4 +- .../sharepoint-pnp/Set-PnPTenantCdnPolicy.md | 4 +- .../sharepoint-pnp/Set-PnPTenantSite.md | 165 ++- .../sharepoint-pnp/Set-PnPTheme.md | 4 +- .../sharepoint-pnp/Set-PnPTraceLog.md | 17 +- .../sharepoint-pnp/Set-PnPUnifiedGroup.md | 6 +- .../Set-PnPUserProfileProperty.md | 10 +- .../sharepoint-pnp/Set-PnPView.md | 26 +- .../sharepoint-pnp/Set-PnPWeb.md | 6 +- .../sharepoint-pnp/Set-PnPWebPartProperty.md | 6 +- .../sharepoint-pnp/Set-PnPWebPermission.md | 4 +- .../sharepoint-pnp/Set-PnPWebTheme.md | 4 +- .../Set-PnPWebhookSubscription.md | 4 +- .../sharepoint-pnp/Set-PnPWikiPageContent.md | 4 +- .../Start-PnPWorkflowInstance.md | 8 +- .../Stop-PnPWorkflowInstance.md | 4 +- .../sharepoint-pnp/Submit-PnPSearchQuery.md | 6 +- .../sharepoint-pnp/Sync-PnPAppToTeams.md | 4 +- .../Test-PnPListItemIsRecord.md | 4 +- .../Test-PnPOffice365GroupAliasIsUsed.md | 4 +- .../sharepoint-pnp/Test-PnPTenantTemplate.md | 5 +- .../sharepoint-pnp/Uninstall-PnPApp.md | 4 +- .../Uninstall-PnPAppInstance.md | 4 +- .../sharepoint-pnp/Uninstall-PnPSolution.md | 4 +- .../sharepoint-pnp/Unpublish-PnPApp.md | 4 +- .../sharepoint-pnp/Unregister-PnPHubSite.md | 4 +- .../sharepoint-pnp/Update-PnPApp.md | 4 +- .../Update-PnPSiteClassification.md | 4 +- 404 files changed, 4826 insertions(+), 1423 deletions(-) create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApplicationCustomizer.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOrgAssetsLibrary.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOrgNewsSite.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTeamsTeam.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPListToProvisioningTemplate.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPApplicationCustomizer.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDeletedUnifiedGroup.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHubSiteChild.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPManagementApiAccessToken.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPOrgAssetsLibrary.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPOrgNewsSite.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchSettings.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantId.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantTemplate.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedAuditLog.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPApplicationCustomizer.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPDeletedUnifiedGroup.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPOrgAssetsLibrary.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPOrgNewsSite.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPAccessToken.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Reset-PnPLabel.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnPDeletedUnifiedGroup.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPApplicationCustomizer.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFolderPermission.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSearchSettings.md diff --git a/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md b/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md index ad7b2009b1..c0d1ad13d4 100644 --- a/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md +++ b/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md @@ -1,27 +1,21 @@ ---- -title: SharePoint PnP Cmdlets ---- - # PnP PowerShell overview -SharePoint Patterns and Practices (PnP) contains a library of PowerShell commands (PnP PowerShell) that allows you to perform complex provisioning and artifact management actions towards SharePoint. The commands use CSOM and REST APIs. They do work against both SharePoint Online as SharePoint on-premises. +SharePoint Patterns and Practices (PnP) contains a library of PowerShell commands (PnP PowerShell) that allows you to perform complex provisioning and artifact management actions towards SharePoint. The commands use CSOM and can work against both SharePoint Online as SharePoint On-Premises. -![SharePoint Patterns and Practices](https://raw.githubusercontent.com/pnp/media/master/pnp-logos-sp/png/1x/SharePoint_PnP_logo_fullcolor.png) +![SharePoint Patterns and Practices](https://devofficecdn.azureedge.net/media/Default/PnP/sppnp.png) -_**Applies to:** SharePoint Online | Sharepoint 2019 | SharePoint 2016 | SharePoint 2013_ +_**Applies to:** SharePoint Online | SharePoint 2016 | SharePoint 2013_ -## Installation +## Installation # There are 3 ways to install the cmdlets. We recommend, where possible, to install them from the [PowerShell Gallery](https://www.powershellgallery.com). Alternatively you can download the setup files or run a PowerShell script to download the PowerShellGet module and install the cmdlets subsequently. -### PowerShell Gallery - +### PowerShell Gallery ### If you main OS is Windows 10, or if you have [PowerShellGet](https://github.com/powershell/powershellget) installed, you can run the following commands to install the PowerShell cmdlets: |**SharePoint Version**|**Command to install**| |------------------|------------------| |SharePoint Online|```Install-Module SharePointPnPPowerShellOnline ```| -|SharePoint 2019|```Install-Module SharePointPnPPowerShell2019```| |SharePoint 2016|```Install-Module SharePointPnPPowerShell2016```| |SharePoint 2013|```Install-Module SharePointPnPPowerShell2013```| @@ -30,12 +24,10 @@ If you main OS is Windows 10, or if you have [PowerShellGet](https://github.com/ In order to install the cmdlets when you get this error specify the -SkipPublisherCheck switch with the Install-Module cmdlet, e.g. ```Install-Module SharePointPnPPowerShellOnline -SkipPublisherCheck -AllowClobber``` -### Setup files - +### Setup files ## You can download setup files from the [releases](https://github.com/sharepoint/pnp-powershell/releases) section of the PnP PowerShell repository. These files will up be updated on a monthly basis. Run the install and restart any open instances of PowerShell to use the cmdlets. -### Installation script - +### Installation script ## This is an alternative for installation on machines that have at least PowerShell v3 installed. You can find the version of PowerShell by opening PowerShell and running ```$PSVersionTable.PSVersion```. The value for ```Major``` should be above 3. To install the cmdlets you can run the below command which will install PowerShell Package Management and then install the PowerShell Modules from the PowerShell Gallery. @@ -44,8 +36,7 @@ To install the cmdlets you can run the below command which will install PowerShe Invoke-Expression (New-Object Net.WebClient).DownloadString('https://raw.githubusercontent.com/sharepoint/PnP-PowerShell/master/Samples/Modules.Install/Install-SharePointPnPPowerShell.ps1') ``` -## Updating - +## Updating ## Every month a new release will be made available of the PnP PowerShell Cmdlets. If you earlier installed the cmdlets using the setup file, simply download the [latest version](https://github.com/SharePoint/PnP-PowerShell/releases/latest) and run the setup. This will update your existing installation. If you have installed the cmdlets using PowerShellGet with ```Install-Module``` from the PowerShell Gallery then you will be able to use the following command to install the latest updated version: @@ -62,12 +53,12 @@ You can check the installed PnP-PowerShell versions with the following command: Get-Module SharePointPnPPowerShell* -ListAvailable | Select-Object Name,Version | Sort-Object Version -Descending ``` -## Getting Started +## Getting Started # To use the library you first need to connect to your tenant: ```powershell -Connect-PnPOnline -Url https://yoursite.sharepoint.com -Credentials (Get-Credential) +Connect-PnPOnline –Url https://yoursite.sharepoint.com –Credentials (Get-Credential) ``` Notice: if you use multi-factor authentication on your tenant, use @@ -88,539 +79,566 @@ At the following links you will find a few videos on how to get started with the * https://channel9.msdn.com/blogs/OfficeDevPnP/Introduction-to-PnP-PowerShell-Cmdlets * https://channel9.msdn.com/blogs/OfficeDevPnP/PnP-Webcast-PnP-PowerShell-Getting-started-with-latest-updates -### Setting up credentials - +### Setting up credentials ## See this [wiki page](https://github.com/SharePoint/PnP-PowerShell/wiki/How-to-use-the-Windows-Credential-Manager-to-ease-authentication-with-PnP-PowerShell) for more information on how to use the Windows Credential Manager to setup credentials that you can use in unattended scripts ## Cmdlet overview -### Apps +### Apps Cmdlet|Description|Platform :-----|:----------|:------- -**[Add-PnPApp](../../sharepoint-ps/sharepoint-pnp/Add-PnPApp.md)** |Add/uploads an available app to the app catalog|SharePoint Online, SharePoint 2019 -**[Get-PnPApp](../../sharepoint-ps/sharepoint-pnp/Get-PnPApp.md)** |Returns the available apps from the app catalog|SharePoint Online, SharePoint 2019 -**[Install-PnPApp](../../sharepoint-ps/sharepoint-pnp/Install-PnPApp.md)** |Installs an available app from the app catalog|SharePoint Online, SharePoint 2019 -**[Publish-PnPApp](../../sharepoint-ps/sharepoint-pnp/Publish-PnPApp.md)** |Publishes/Deploys/Trusts an available app in the app catalog|SharePoint Online, SharePoint 2019 -**[Remove-PnPApp](../../sharepoint-ps/sharepoint-pnp/Remove-PnPApp.md)** |Removes an app from the app catalog|SharePoint Online, SharePoint 2019 -**[Uninstall-PnPApp](../../sharepoint-ps/sharepoint-pnp/Uninstall-PnPApp.md)** |Uninstalls an available add-in from the site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Unpublish-PnPApp](../../sharepoint-ps/sharepoint-pnp/Unpublish-PnPApp.md)** |Unpublishes/retracts an available add-in from the app catalog|SharePoint Online, SharePoint 2019 -**[Update-PnPApp](../../sharepoint-ps/sharepoint-pnp/Update-PnPApp.md)** |Updates an available app from the app catalog|SharePoint Online, SharePoint 2019 -**[Get-PnPAppInstance](../../sharepoint-ps/sharepoint-pnp/Get-PnPAppInstance.md)** |Returns a SharePoint AddIn Instance|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Uninstall-PnPAppInstance](../../sharepoint-ps/sharepoint-pnp/Uninstall-PnPAppInstance.md)** |Removes an app from a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Import-PnPAppPackage](../../sharepoint-ps/sharepoint-pnp/Import-PnPAppPackage.md)** |Adds a SharePoint Addin to a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Sync-PnPAppToTeams](../../sharepoint-ps/sharepoint-pnp/Sync-PnPAppToTeams.md)** |Synchronize an app from the tenant app catalog to the Microsoft Teams app catalog|SharePoint Online -**[Grant-PnPTenantServicePrincipalPermission](../../sharepoint-ps/sharepoint-pnp/Grant-PnPTenantServicePrincipalPermission.md)** |Explicitly grants a specified permission to the "SharePoint Online Client" service principal|SharePoint Online - - -### Base Cmdlets - +**[Add‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Add-PnPApp.md)** |Add/uploads an available app to the app catalog|SharePoint Online, SharePoint 2019 +**[Get‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Get-PnPApp.md)** |Returns the available apps from the app catalog|SharePoint Online, SharePoint 2019 +**[Install‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Install-PnPApp.md)** |Installs an available app from the app catalog|SharePoint Online, SharePoint 2019 +**[Publish‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Publish-PnPApp.md)** |Publishes/Deploys/Trusts an available app in the app catalog|SharePoint Online, SharePoint 2019 +**[Remove‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Remove-PnPApp.md)** |Removes an app from the app catalog|SharePoint Online, SharePoint 2019 +**[Uninstall‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Uninstall-PnPApp.md)** |Uninstalls an available add-in from the site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Unpublish‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Unpublish-PnPApp.md)** |Unpublishes/retracts an available add-in from the app catalog|SharePoint Online, SharePoint 2019 +**[Update‑PnPApp](../../sharepoint-ps/sharepoint-pnp/Update-PnPApp.md)** |Updates an available app from the app catalog|SharePoint Online, SharePoint 2019 +**[Get‑PnPAppInstance](../../sharepoint-ps/sharepoint-pnp/Get-PnPAppInstance.md)** |Returns a SharePoint AddIn Instance|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Uninstall‑PnPAppInstance](../../sharepoint-ps/sharepoint-pnp/Uninstall-PnPAppInstance.md)** |Removes an app from a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPApplicationCustomizer](../../sharepoint-ps/sharepoint-pnp/Add-PnPApplicationCustomizer.md)** |Adds a SharePoint Framework client side extension application customizer|SharePoint Online, SharePoint 2019 +**[Get‑PnPApplicationCustomizer](../../sharepoint-ps/sharepoint-pnp/Get-PnPApplicationCustomizer.md)** |Returns all SharePoint Framework client side extension application customizers|SharePoint Online, SharePoint 2019 +**[Remove‑PnPApplicationCustomizer](../../sharepoint-ps/sharepoint-pnp/Remove-PnPApplicationCustomizer.md)** |Removes a SharePoint Framework client side extension application customizer|SharePoint Online, SharePoint 2019 +**[Set‑PnPApplicationCustomizer](../../sharepoint-ps/sharepoint-pnp/Set-PnPApplicationCustomizer.md)** |Updates a SharePoint Framework client side extension application customizer|SharePoint Online, SharePoint 2019 +**[Import‑PnPAppPackage](../../sharepoint-ps/sharepoint-pnp/Import-PnPAppPackage.md)** |Adds a SharePoint Addin to a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Sync‑PnPAppToTeams](../../sharepoint-ps/sharepoint-pnp/Sync-PnPAppToTeams.md)** |Synchronize an app from the tenant app catalog to the Microsoft Teams app catalog|SharePoint Online +**[Grant‑PnPTenantServicePrincipalPermission](../../sharepoint-ps/sharepoint-pnp/Grant-PnPTenantServicePrincipalPermission.md)** |Explicitly grants a specified permission to the "SharePoint Online Client" service principal|SharePoint Online + + +### Base Cmdlets Cmdlet|Description|Platform :-----|:----------|:------- -**[Get-PnPAppAuthAccessToken](../../sharepoint-ps/sharepoint-pnp/Get-PnPAppAuthAccessToken.md)** |Returns the access token|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPAuthenticationRealm](../../sharepoint-ps/sharepoint-pnp/Get-PnPAuthenticationRealm.md)** |Returns the authentication realm|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPAzureADManifestKeyCredentials](../../sharepoint-ps/sharepoint-pnp/Get-PnPAzureADManifestKeyCredentials.md)** |Return the JSON Manifest snippet for Azure Apps|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPAzureCertificate](../../sharepoint-ps/sharepoint-pnp/Get-PnPAzureCertificate.md)** |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.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[New-PnPAzureCertificate](../../sharepoint-ps/sharepoint-pnp/New-PnPAzureCertificate.md)** |Generate a new 2048bit self-signed certificate and manifest settings for use when using CSOM via an app-only ADAL application. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. KeyCredentials contains the ADAL app manifest sections. Certificate contains the PEM encoded certificate. PrivateKey contains the PEM encoded private key of the certificate.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPConnection](../../sharepoint-ps/sharepoint-pnp/Get-PnPConnection.md)** |Returns the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPContext](../../sharepoint-ps/sharepoint-pnp/Get-PnPContext.md)** |Returns the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPContext](../../sharepoint-ps/sharepoint-pnp/Set-PnPContext.md)** |Set the ClientContext|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPException](../../sharepoint-ps/sharepoint-pnp/Get-PnPException.md)** |Returns the last exception that occurred|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPHealthScore](../../sharepoint-ps/sharepoint-pnp/Get-PnPHealthScore.md)** |Retrieves the healthscore value.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Connect-PnPOnline](../../sharepoint-ps/sharepoint-pnp/Connect-PnPOnline.md)** |Connect to a SharePoint site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Disconnect-PnPOnline](../../sharepoint-ps/sharepoint-pnp/Disconnect-PnPOnline.md)** |Disconnects the context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPProperty](../../sharepoint-ps/sharepoint-pnp/Get-PnPProperty.md)** |Returns a previously not loaded property of a ClientObject|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Invoke-PnPQuery](../../sharepoint-ps/sharepoint-pnp/Invoke-PnPQuery.md)** |Executes the currently queued actions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Invoke-PnPSPRestMethod](../../sharepoint-ps/sharepoint-pnp/Invoke-PnPSPRestMethod.md)** |Invokes a REST request towards a SharePoint site|SharePoint Online -**[Add-PnPStoredCredential](../../sharepoint-ps/sharepoint-pnp/Add-PnPStoredCredential.md)** |Adds a credential to the Windows Credential Manager|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPStoredCredential](../../sharepoint-ps/sharepoint-pnp/Get-PnPStoredCredential.md)** |Get a credential|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPStoredCredential](../../sharepoint-ps/sharepoint-pnp/Remove-PnPStoredCredential.md)** |Removes a credential|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPTraceLog](../../sharepoint-ps/sharepoint-pnp/Set-PnPTraceLog.md)** |Turn log tracing on or off|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Request‑PnPAccessToken](../../sharepoint-ps/sharepoint-pnp/Request-PnPAccessToken.md)** |Requests an OAuth Access token|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPAppAuthAccessToken](../../sharepoint-ps/sharepoint-pnp/Get-PnPAppAuthAccessToken.md)** |Returns the access token|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPAuthenticationRealm](../../sharepoint-ps/sharepoint-pnp/Get-PnPAuthenticationRealm.md)** |Returns the authentication realm|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPAzureCertificate](../../sharepoint-ps/sharepoint-pnp/Get-PnPAzureCertificate.md)** |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.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPAzureCertificate](../../sharepoint-ps/sharepoint-pnp/New-PnPAzureCertificate.md)** |Generate a new 2048bit self-signed certificate and manifest settings for use when using CSOM via an app-only ADAL application. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. KeyCredentials contains the ADAL app manifest sections. Certificate contains the PEM encoded certificate. PrivateKey contains the PEM encoded private key of the certificate.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPConnection](../../sharepoint-ps/sharepoint-pnp/Get-PnPConnection.md)** |Returns the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPContext](../../sharepoint-ps/sharepoint-pnp/Get-PnPContext.md)** |Returns the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPContext](../../sharepoint-ps/sharepoint-pnp/Set-PnPContext.md)** |Set the ClientContext|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPException](../../sharepoint-ps/sharepoint-pnp/Get-PnPException.md)** |Returns the last exception that occurred|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPHealthScore](../../sharepoint-ps/sharepoint-pnp/Get-PnPHealthScore.md)** |Retrieves the healthscore of the site given in his Url parameter or from the current connection if the Url parameter is not provided|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +**[Connect‑PnPOnline](../../sharepoint-ps/sharepoint-pnp/Connect-PnPOnline.md)** |Connect to a SharePoint site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Disconnect‑PnPOnline](../../sharepoint-ps/sharepoint-pnp/Disconnect-PnPOnline.md)** |Disconnects the context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPProperty](../../sharepoint-ps/sharepoint-pnp/Get-PnPProperty.md)** |Returns a previously not loaded property of a ClientObject|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Invoke‑PnPQuery](../../sharepoint-ps/sharepoint-pnp/Invoke-PnPQuery.md)** |Executes the currently queued actions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Invoke‑PnPSPRestMethod](../../sharepoint-ps/sharepoint-pnp/Invoke-PnPSPRestMethod.md)** |Invokes a REST request towards a SharePoint site|SharePoint Online +**[Add‑PnPStoredCredential](../../sharepoint-ps/sharepoint-pnp/Add-PnPStoredCredential.md)** |Adds a credential to the Windows Credential Manager|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPStoredCredential](../../sharepoint-ps/sharepoint-pnp/Get-PnPStoredCredential.md)** |Get a credential|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPStoredCredential](../../sharepoint-ps/sharepoint-pnp/Remove-PnPStoredCredential.md)** |Removes a credential|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPTraceLog](../../sharepoint-ps/sharepoint-pnp/Set-PnPTraceLog.md)** |Turn log tracing on or off|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -### Branding +### Branding Cmdlet|Description|Platform :-----|:----------|:------- -**[Add-PnPCustomAction](../../sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md)** |Adds a custom action|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPCustomAction](../../sharepoint-ps/sharepoint-pnp/Get-PnPCustomAction.md)** |Return user custom actions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPCustomAction](../../sharepoint-ps/sharepoint-pnp/Remove-PnPCustomAction.md)** |Removes a custom action|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPHomePage](../../sharepoint-ps/sharepoint-pnp/Get-PnPHomePage.md)** |Return the homepage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPHomePage](../../sharepoint-ps/sharepoint-pnp/Set-PnPHomePage.md)** |Sets the home page of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPJavaScriptBlock](../../sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptBlock.md)** |Adds a link to a JavaScript snippet/block to a web or site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPJavaScriptLink](../../sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptLink.md)** |Adds a link to a JavaScript file to a web or sitecollection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPJavaScriptLink](../../sharepoint-ps/sharepoint-pnp/Get-PnPJavaScriptLink.md)** |Returns all or a specific custom action(s) with location type ScriptLink|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPJavaScriptLink](../../sharepoint-ps/sharepoint-pnp/Remove-PnPJavaScriptLink.md)** |Removes a JavaScript link or block from a web or sitecollection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPMasterPage](../../sharepoint-ps/sharepoint-pnp/Get-PnPMasterPage.md)** |Returns the URLs of the default Master Page and the custom Master Page.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPMasterPage](../../sharepoint-ps/sharepoint-pnp/Set-PnPMasterPage.md)** |Set the masterpage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPMinimalDownloadStrategy](../../sharepoint-ps/sharepoint-pnp/Set-PnPMinimalDownloadStrategy.md)** |Activates or deactivates the minimal downloading strategy.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPNavigationNode](../../sharepoint-ps/sharepoint-pnp/Add-PnPNavigationNode.md)** |Adds an item to a navigation element|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPNavigationNode](../../sharepoint-ps/sharepoint-pnp/Get-PnPNavigationNode.md)** |Returns all or a specific navigation node|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPNavigationNode](../../sharepoint-ps/sharepoint-pnp/Remove-PnPNavigationNode.md)** |Removes a menu item from either the quicklaunch or top navigation|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Disable-PnPResponsiveUI](../../sharepoint-ps/sharepoint-pnp/Disable-PnPResponsiveUI.md)** |Deactivate the PnP Response UI add-on|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Enable-PnPResponsiveUI](../../sharepoint-ps/sharepoint-pnp/Enable-PnPResponsiveUI.md)** |Activates the PnP Response UI Add-on|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPTheme](../../sharepoint-ps/sharepoint-pnp/Get-PnPTheme.md)** |Returns the current theme/composed look of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPTheme](../../sharepoint-ps/sharepoint-pnp/Set-PnPTheme.md)** |Sets the theme of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPWebTheme](../../sharepoint-ps/sharepoint-pnp/Set-PnPWebTheme.md)** |Sets the theme of the current web.|SharePoint Online - -### Client-Side Pages - +**[Add‑PnPCustomAction](../../sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md)** |Adds a custom action|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPCustomAction](../../sharepoint-ps/sharepoint-pnp/Get-PnPCustomAction.md)** |Return user custom actions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPCustomAction](../../sharepoint-ps/sharepoint-pnp/Remove-PnPCustomAction.md)** |Removes a custom action|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPHomePage](../../sharepoint-ps/sharepoint-pnp/Get-PnPHomePage.md)** |Return the homepage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPHomePage](../../sharepoint-ps/sharepoint-pnp/Set-PnPHomePage.md)** |Sets the home page of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPJavaScriptBlock](../../sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptBlock.md)** |Adds a link to a JavaScript snippet/block to a web or site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPJavaScriptLink](../../sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptLink.md)** |Adds a link to a JavaScript file to a web or sitecollection, valid only for SharePoint classic site experience.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPJavaScriptLink](../../sharepoint-ps/sharepoint-pnp/Get-PnPJavaScriptLink.md)** |Returns all or a specific custom action(s) with location type ScriptLink|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPJavaScriptLink](../../sharepoint-ps/sharepoint-pnp/Remove-PnPJavaScriptLink.md)** |Removes a JavaScript link or block from a web or sitecollection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPMasterPage](../../sharepoint-ps/sharepoint-pnp/Get-PnPMasterPage.md)** |Returns the URLs of the default Master Page and the custom Master Page.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPMasterPage](../../sharepoint-ps/sharepoint-pnp/Set-PnPMasterPage.md)** |Set the masterpage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPMinimalDownloadStrategy](../../sharepoint-ps/sharepoint-pnp/Set-PnPMinimalDownloadStrategy.md)** |Activates or deactivates the minimal downloading strategy.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPNavigationNode](../../sharepoint-ps/sharepoint-pnp/Add-PnPNavigationNode.md)** |Adds an item to a navigation element|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPNavigationNode](../../sharepoint-ps/sharepoint-pnp/Get-PnPNavigationNode.md)** |Returns all or a specific navigation node|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPNavigationNode](../../sharepoint-ps/sharepoint-pnp/Remove-PnPNavigationNode.md)** |Removes a menu item from either the quicklaunch or top navigation|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Disable‑PnPResponsiveUI](../../sharepoint-ps/sharepoint-pnp/Disable-PnPResponsiveUI.md)** |Deactivate the PnP Response UI add-on|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Enable‑PnPResponsiveUI](../../sharepoint-ps/sharepoint-pnp/Enable-PnPResponsiveUI.md)** |Activates the PnP Response UI Add-on|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPTheme](../../sharepoint-ps/sharepoint-pnp/Get-PnPTheme.md)** |Returns the current theme/composed look of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPTheme](../../sharepoint-ps/sharepoint-pnp/Set-PnPTheme.md)** |Sets the theme of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPWebTheme](../../sharepoint-ps/sharepoint-pnp/Set-PnPWebTheme.md)** |Sets the theme of the current web.|SharePoint Online + + +### Client-Side Pages Cmdlet|Description|Platform :-----|:----------|:------- -**[Get-PnPAvailableClientSideComponents](../../sharepoint-ps/sharepoint-pnp/Get-PnPAvailableClientSideComponents.md)** |Gets the available client side components on a particular page|SharePoint Online, SharePoint 2019 -**[Move-PnPClientSideComponent](../../sharepoint-ps/sharepoint-pnp/Move-PnPClientSideComponent.md)** |Moves a Client-Side Component to a different section/column|SharePoint Online, SharePoint 2019 -**[Add-PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePage.md)** |Adds a Client-Side Page|SharePoint Online, SharePoint 2019 -**[ConvertTo-PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/ConvertTo-PnPClientSidePage.md)** |Converts a classic page (wiki or web part page) into a Client-Side Page|SharePoint Online -**[Get-PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Get-PnPClientSidePage.md)** |Gets a Client-Side Page|SharePoint Online, SharePoint 2019 -**[Remove-PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Remove-PnPClientSidePage.md)** |Removes a Client-Side Page|SharePoint Online, SharePoint 2019 -**[Set-PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Set-PnPClientSidePage.md)** |Sets parameters of a Client-Side Page|SharePoint Online, SharePoint 2019 -**[Save-PnPClientSidePageConversionLog](../../sharepoint-ps/sharepoint-pnp/Save-PnPClientSidePageConversionLog.md)** |Persists the current client side page conversion log data to the loggers linked to the last used page transformation run. Needs to be used in conjunction with the -LogSkipFlush flag on the ConvertTo-PnPClientSidePage cmdlet|SharePoint Online -**[Export-PnPClientSidePageMapping](../../sharepoint-ps/sharepoint-pnp/Export-PnPClientSidePageMapping.md)** |Get's the built-in maping files or a custom mapping file for your publishing portal page layouts. These mapping files are used to tailor the page transformation experience.|SharePoint Online -**[Add-PnPClientSidePageSection](../../sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePageSection.md)** |Adds a new section to a Client-Side page|SharePoint Online, SharePoint 2019 -**[Add-PnPClientSideText](../../sharepoint-ps/sharepoint-pnp/Add-PnPClientSideText.md)** |Adds a text element to a client-side page.|SharePoint Online, SharePoint 2019 -**[Add-PnPClientSideWebPart](../../sharepoint-ps/sharepoint-pnp/Add-PnPClientSideWebPart.md)** |Adds a Client-Side Web Part to a client-side page|SharePoint Online - -### Content Types - +**[Get‑PnPAvailableClientSideComponents](../../sharepoint-ps/sharepoint-pnp/Get-PnPAvailableClientSideComponents.md)** |Gets the available client side components on a particular page|SharePoint Online, SharePoint 2019 +**[Move‑PnPClientSideComponent](../../sharepoint-ps/sharepoint-pnp/Move-PnPClientSideComponent.md)** |Moves a Client-Side Component to a different section/column|SharePoint Online, SharePoint 2019 +**[Add‑PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePage.md)** |Adds a Client-Side Page|SharePoint Online, SharePoint 2019 +**[ConvertTo‑PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/ConvertTo-PnPClientSidePage.md)** |Converts a classic page (wiki or web part page) into a Client-Side Page|SharePoint Online +**[Get‑PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Get-PnPClientSidePage.md)** |Gets a Client-Side Page|SharePoint Online, SharePoint 2019 +**[Remove‑PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Remove-PnPClientSidePage.md)** |Removes a Client-Side Page|SharePoint Online, SharePoint 2019 +**[Set‑PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Set-PnPClientSidePage.md)** |Sets parameters of a Client-Side Page|SharePoint Online, SharePoint 2019 +**[Save‑PnPClientSidePageConversionLog](../../sharepoint-ps/sharepoint-pnp/Save-PnPClientSidePageConversionLog.md)** |Persists the current client side page conversion log data to the loggers linked to the last used page transformation run. Needs to be used in conjunction with the -LogSkipFlush flag on the ConvertTo-PnPClientSidePage cmdlet|SharePoint Online +**[Export‑PnPClientSidePageMapping](../../sharepoint-ps/sharepoint-pnp/Export-PnPClientSidePageMapping.md)** |Get's the built-in maping files or a custom mapping file for your publishing portal page layouts. These mapping files are used to tailor the page transformation experience.|SharePoint Online +**[Add‑PnPClientSidePageSection](../../sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePageSection.md)** |Adds a new section to a Client-Side page|SharePoint Online, SharePoint 2019 +**[Add‑PnPClientSideText](../../sharepoint-ps/sharepoint-pnp/Add-PnPClientSideText.md)** |Adds a text element to a client-side page.|SharePoint Online, SharePoint 2019 +**[Add‑PnPClientSideWebPart](../../sharepoint-ps/sharepoint-pnp/Add-PnPClientSideWebPart.md)** |Adds a Client-Side Web Part to a client-side page|SharePoint Online, SharePoint 2019 + + +### Content Types Cmdlet|Description|Platform :-----|:----------|:------- -**[Add-PnPContentType](../../sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md)** |Adds a new content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPContentType](../../sharepoint-ps/sharepoint-pnp/Get-PnPContentType.md)** |Retrieves a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPContentType](../../sharepoint-ps/sharepoint-pnp/Remove-PnPContentType.md)** |Removes a content type from a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPContentTypeFromList](../../sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromList.md)** |Removes a content type from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPContentTypePublishingHubUrl](../../sharepoint-ps/sharepoint-pnp/Get-PnPContentTypePublishingHubUrl.md)** |Returns the url to Content Type Publishing Hub|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPContentTypeToList](../../sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md)** |Adds a new content type to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPDefaultContentTypeToList](../../sharepoint-ps/sharepoint-pnp/Set-PnPDefaultContentTypeToList.md)** |Sets the default content type for a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPFieldFromContentType](../../sharepoint-ps/sharepoint-pnp/Remove-PnPFieldFromContentType.md)** |Removes a site column from a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPFieldToContentType](../../sharepoint-ps/sharepoint-pnp/Add-PnPFieldToContentType.md)** |Adds an existing site column to a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online - -### Diagnostic utilities - +**[Add‑PnPContentType](../../sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md)** |Adds a new content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPContentType](../../sharepoint-ps/sharepoint-pnp/Get-PnPContentType.md)** |Retrieves a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPContentType](../../sharepoint-ps/sharepoint-pnp/Remove-PnPContentType.md)** |Removes a content type from a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPContentTypeFromList](../../sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromList.md)** |Removes a content type from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPContentTypePublishingHubUrl](../../sharepoint-ps/sharepoint-pnp/Get-PnPContentTypePublishingHubUrl.md)** |Returns the url to Content Type Publishing Hub|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPContentTypeToList](../../sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md)** |Adds a new content type to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPDefaultContentTypeToList](../../sharepoint-ps/sharepoint-pnp/Set-PnPDefaultContentTypeToList.md)** |Sets the default content type for a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPFieldFromContentType](../../sharepoint-ps/sharepoint-pnp/Remove-PnPFieldFromContentType.md)** |Removes a site column from a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPFieldToContentType](../../sharepoint-ps/sharepoint-pnp/Add-PnPFieldToContentType.md)** |Adds an existing site column to a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Diagnostic utilities Cmdlet|Description|Platform :-----|:----------|:------- -**[Measure-PnPList](../../sharepoint-ps/sharepoint-pnp/Measure-PnPList.md)** |Returns statistics on the list object|SharePoint Online, SharePoint 2016, SharePoint 2019 -**[Measure-PnPResponseTime](../../sharepoint-ps/sharepoint-pnp/Measure-PnPResponseTime.md)** |Gets statistics on response time for the specified endpoint by sending probe requests|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Measure-PnPWeb](../../sharepoint-ps/sharepoint-pnp/Measure-PnPWeb.md)** |Returns statistics on the web object|SharePoint Online, SharePoint 2016, SharePoint 2019 +**[Measure‑PnPList](../../sharepoint-ps/sharepoint-pnp/Measure-PnPList.md)** |Returns statistics on the list object|SharePoint Online, SharePoint 2016, SharePoint 2019 +**[Measure‑PnPResponseTime](../../sharepoint-ps/sharepoint-pnp/Measure-PnPResponseTime.md)** |Gets statistics on response time for the specified endpoint by sending probe requests|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Measure‑PnPWeb](../../sharepoint-ps/sharepoint-pnp/Measure-PnPWeb.md)** |Returns statistics on the web object|SharePoint Online, SharePoint 2016, SharePoint 2019 -### Document Sets +### Document Sets Cmdlet|Description|Platform :-----|:----------|:------- -**[Remove-PnPContentTypeFromDocumentSet](../../sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromDocumentSet.md)** |Removes a content type from a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPContentTypeToDocumentSet](../../sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md)** |Adds a content type to a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPDocumentSet](../../sharepoint-ps/sharepoint-pnp/Add-PnPDocumentSet.md)** |Creates a new document set in a library.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPDocumentSetField](../../sharepoint-ps/sharepoint-pnp/Set-PnPDocumentSetField.md)** |Sets a site column from the available content types to a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPDocumentSetTemplate](../../sharepoint-ps/sharepoint-pnp/Get-PnPDocumentSetTemplate.md)** |Retrieves a document set template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPContentTypeFromDocumentSet](../../sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromDocumentSet.md)** |Removes a content type from a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPContentTypeToDocumentSet](../../sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md)** |Adds a content type to a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPDocumentSet](../../sharepoint-ps/sharepoint-pnp/Add-PnPDocumentSet.md)** |Creates a new document set in a library.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPDocumentSetField](../../sharepoint-ps/sharepoint-pnp/Set-PnPDocumentSetField.md)** |Sets a site column from the available content types to a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPDocumentSetTemplate](../../sharepoint-ps/sharepoint-pnp/Get-PnPDocumentSetTemplate.md)** |Retrieves a document set template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -### Event Receivers +### Event Receivers Cmdlet|Description|Platform :-----|:----------|:------- -**[Add-PnPEventReceiver](../../sharepoint-ps/sharepoint-pnp/Add-PnPEventReceiver.md)** |Adds a new remote event receiver|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPEventReceiver](../../sharepoint-ps/sharepoint-pnp/Get-PnPEventReceiver.md)** |Return registered eventreceivers|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPEventReceiver](../../sharepoint-ps/sharepoint-pnp/Remove-PnPEventReceiver.md)** |Remove an eventreceiver|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPEventReceiver](../../sharepoint-ps/sharepoint-pnp/Add-PnPEventReceiver.md)** |Adds a new remote event receiver|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPEventReceiver](../../sharepoint-ps/sharepoint-pnp/Get-PnPEventReceiver.md)** |Return registered eventreceivers|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPEventReceiver](../../sharepoint-ps/sharepoint-pnp/Remove-PnPEventReceiver.md)** |Remove an eventreceiver|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -### Features +### Features Cmdlet|Description|Platform :-----|:----------|:------- -**[New-PnPExtensibilityHandlerObject](../../sharepoint-ps/sharepoint-pnp/New-PnPExtensibilityHandlerObject.md)** |Creates an ExtensibilityHandler Object, to be used by the Get-SPOProvisioningTemplate cmdlet|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Disable-PnPFeature](../../sharepoint-ps/sharepoint-pnp/Disable-PnPFeature.md)** |Disables a feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Enable-PnPFeature](../../sharepoint-ps/sharepoint-pnp/Enable-PnPFeature.md)** |Enables a feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPFeature](../../sharepoint-ps/sharepoint-pnp/Get-PnPFeature.md)** |Returns all activated or a specific activated feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPExtensibilityHandlerObject](../../sharepoint-ps/sharepoint-pnp/New-PnPExtensibilityHandlerObject.md)** |Creates an ExtensibilityHandler Object, to be used by the Get-PnPProvisioningTemplate cmdlet|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Disable‑PnPFeature](../../sharepoint-ps/sharepoint-pnp/Disable-PnPFeature.md)** |Disables a feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Enable‑PnPFeature](../../sharepoint-ps/sharepoint-pnp/Enable-PnPFeature.md)** |Enables a feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPFeature](../../sharepoint-ps/sharepoint-pnp/Get-PnPFeature.md)** |Returns all activated or a specific activated feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -### Fields +### Fields Cmdlet|Description|Platform :-----|:----------|:------- -**[Add-PnPField](../../sharepoint-ps/sharepoint-pnp/Add-PnPField.md)** |Add a field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPField](../../sharepoint-ps/sharepoint-pnp/Get-PnPField.md)** |Returns a field from a list or site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPField](../../sharepoint-ps/sharepoint-pnp/Remove-PnPField.md)** |Removes a field from a list or a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPField](../../sharepoint-ps/sharepoint-pnp/Set-PnPField.md)** |Changes one or more properties of a field in a specific list or for the whole web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPFieldFromXml](../../sharepoint-ps/sharepoint-pnp/Add-PnPFieldFromXml.md)** |Adds a field to a list or as a site column based upon a CAML/XML field definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPTaxonomyField](../../sharepoint-ps/sharepoint-pnp/Add-PnPTaxonomyField.md)** |Add a taxonomy field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPView](../../sharepoint-ps/sharepoint-pnp/Set-PnPView.md)** |Change view properties|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPField](../../sharepoint-ps/sharepoint-pnp/Add-PnPField.md)** |Add a field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPField](../../sharepoint-ps/sharepoint-pnp/Get-PnPField.md)** |Returns a field from a list or site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPField](../../sharepoint-ps/sharepoint-pnp/Remove-PnPField.md)** |Removes a field from a list or a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPField](../../sharepoint-ps/sharepoint-pnp/Set-PnPField.md)** |Changes one or more properties of a field in a specific list or for the whole web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPFieldFromXml](../../sharepoint-ps/sharepoint-pnp/Add-PnPFieldFromXml.md)** |Adds a field to a list or as a site column based upon a CAML/XML field definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPTaxonomyField](../../sharepoint-ps/sharepoint-pnp/Add-PnPTaxonomyField.md)** |Add a taxonomy field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPView](../../sharepoint-ps/sharepoint-pnp/Set-PnPView.md)** |Change view properties|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -### Files and Folders +### Files and Folders Cmdlet|Description|Platform :-----|:----------|:------- -**[Add-PnPFile](../../sharepoint-ps/sharepoint-pnp/Add-PnPFile.md)** |Uploads a file to Web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Copy-PnPFile](../../sharepoint-ps/sharepoint-pnp/Copy-PnPFile.md)** |Copies a file or folder to a different location, currently there is a 200MB file size limit for the file to be copied.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Find-PnPFile](../../sharepoint-ps/sharepoint-pnp/Find-PnPFile.md)** |Finds a file in the virtual file system of the web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPFile](../../sharepoint-ps/sharepoint-pnp/Get-PnPFile.md)** |Downloads a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Move-PnPFile](../../sharepoint-ps/sharepoint-pnp/Move-PnPFile.md)** |Moves a file to a different location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPFile](../../sharepoint-ps/sharepoint-pnp/Remove-PnPFile.md)** |Removes a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Rename-PnPFile](../../sharepoint-ps/sharepoint-pnp/Rename-PnPFile.md)** |Renames a file in its current location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPFileCheckedIn](../../sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedIn.md)** |Checks in a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPFileCheckedOut](../../sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedOut.md)** |Checks out a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Reset-PnPFileVersion](../../sharepoint-ps/sharepoint-pnp/Reset-PnPFileVersion.md)** |Resets a file to its previous version|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPFolder](../../sharepoint-ps/sharepoint-pnp/Add-PnPFolder.md)** |Creates a folder within a parent folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPFolder](../../sharepoint-ps/sharepoint-pnp/Get-PnPFolder.md)** |Return a folder object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Move-PnPFolder](../../sharepoint-ps/sharepoint-pnp/Move-PnPFolder.md)** |Move a folder to another location in the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPFolder](../../sharepoint-ps/sharepoint-pnp/Remove-PnPFolder.md)** |Deletes a folder within a parent folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Rename-PnPFolder](../../sharepoint-ps/sharepoint-pnp/Rename-PnPFolder.md)** |Renames a folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Resolve-PnPFolder](../../sharepoint-ps/sharepoint-pnp/Resolve-PnPFolder.md)** |Returns a folder from a given site relative path, and will create it if it does not exist.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPFolderItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPFolderItem.md)** |List content in folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Copy-PnPItemProxy](../../sharepoint-ps/sharepoint-pnp/Copy-PnPItemProxy.md)** |Proxy cmdlet for using Copy-Item between SharePoint provider and FileSystem provider|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Move-PnPItemProxy](../../sharepoint-ps/sharepoint-pnp/Move-PnPItemProxy.md)** |Proxy cmdlet for using Move-Item between SharePoint provider and FileSystem provider|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online - -### Information Management - +**[Add‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Add-PnPFile.md)** |Uploads a file to Web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Copy‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Copy-PnPFile.md)** |Copies a file or folder to a different location, currently there is a 200MB file size limit for the file to be copied.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Find‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Find-PnPFile.md)** |Finds a file in the virtual file system of the web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Get-PnPFile.md)** |Downloads a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Move‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Move-PnPFile.md)** |Moves a file to a different location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Remove-PnPFile.md)** |Removes a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Rename‑PnPFile](../../sharepoint-ps/sharepoint-pnp/Rename-PnPFile.md)** |Renames a file in its current location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPFileCheckedIn](../../sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedIn.md)** |Checks in a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPFileCheckedOut](../../sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedOut.md)** |Checks out a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Reset‑PnPFileVersion](../../sharepoint-ps/sharepoint-pnp/Reset-PnPFileVersion.md)** |Resets a file to its previous version|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPFolder](../../sharepoint-ps/sharepoint-pnp/Add-PnPFolder.md)** |Creates a folder within a parent folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPFolder](../../sharepoint-ps/sharepoint-pnp/Get-PnPFolder.md)** |Return a folder object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Move‑PnPFolder](../../sharepoint-ps/sharepoint-pnp/Move-PnPFolder.md)** |Move a folder to another location in the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPFolder](../../sharepoint-ps/sharepoint-pnp/Remove-PnPFolder.md)** |Deletes a folder within a parent folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Rename‑PnPFolder](../../sharepoint-ps/sharepoint-pnp/Rename-PnPFolder.md)** |Renames a folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Resolve‑PnPFolder](../../sharepoint-ps/sharepoint-pnp/Resolve-PnPFolder.md)** |Returns a folder from a given site relative path, and will create it if it does not exist.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPFolderItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPFolderItem.md)** |List content in folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Copy‑PnPItemProxy](../../sharepoint-ps/sharepoint-pnp/Copy-PnPItemProxy.md)** |Proxy cmdlet for using Copy-Item between SharePoint provider and FileSystem provider|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Move‑PnPItemProxy](../../sharepoint-ps/sharepoint-pnp/Move-PnPItemProxy.md)** |Proxy cmdlet for using Move-Item between SharePoint provider and FileSystem provider|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Information Management Cmdlet|Description|Platform :-----|:----------|:------- -**[Get-PnPLabel](../../sharepoint-ps/sharepoint-pnp/Get-PnPLabel.md)** |Gets the label/tag of the specified list or library (if applicable)|SharePoint Online -**[Set-PnPLabel](../../sharepoint-ps/sharepoint-pnp/Set-PnPLabel.md)** |Sets a label/tag on the specified list or library|SharePoint Online -**[Get-PnPListInformationRightsManagement](../../sharepoint-ps/sharepoint-pnp/Get-PnPListInformationRightsManagement.md)** |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPListInformationRightsManagement](../../sharepoint-ps/sharepoint-pnp/Set-PnPListInformationRightsManagement.md)** |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPSiteClosure](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteClosure.md)** |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPSiteClosure](../../sharepoint-ps/sharepoint-pnp/Set-PnPSiteClosure.md)** |Opens or closes a site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPSitePolicy](../../sharepoint-ps/sharepoint-pnp/Set-PnPSitePolicy.md)** |Sets a site policy|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPSitePolicy](../../sharepoint-ps/sharepoint-pnp/Get-PnPSitePolicy.md)** |Retrieves all or a specific site policy|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online - -### Lists - +**[Get‑PnPLabel](../../sharepoint-ps/sharepoint-pnp/Get-PnPLabel.md)** |Gets the Office 365 retention label/tag of the specified list or library (if applicable)|SharePoint Online +**[Reset‑PnPLabel](../../sharepoint-ps/sharepoint-pnp/Reset-PnPLabel.md)** |Resets a label/tag on the specified list or library to None|SharePoint Online +**[Set‑PnPLabel](../../sharepoint-ps/sharepoint-pnp/Set-PnPLabel.md)** |Sets a label/tag on the specified list or library. Use Reset-PnPLabel to remove the label again.|SharePoint Online +**[Get‑PnPListInformationRightsManagement](../../sharepoint-ps/sharepoint-pnp/Get-PnPListInformationRightsManagement.md)** |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPListInformationRightsManagement](../../sharepoint-ps/sharepoint-pnp/Set-PnPListInformationRightsManagement.md)** |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPSiteClosure](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteClosure.md)** |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPSiteClosure](../../sharepoint-ps/sharepoint-pnp/Set-PnPSiteClosure.md)** |Opens or closes a site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPSitePolicy](../../sharepoint-ps/sharepoint-pnp/Set-PnPSitePolicy.md)** |Sets a site policy|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPSitePolicy](../../sharepoint-ps/sharepoint-pnp/Get-PnPSitePolicy.md)** |Retrieves all or a specific site policy|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Lists Cmdlet|Description|Platform :-----|:----------|:------- -**[Clear-PnPDefaultColumnValues](../../sharepoint-ps/sharepoint-pnp/Clear-PnPDefaultColumnValues.md)** |Clear default column values for a document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPDefaultColumnValues](../../sharepoint-ps/sharepoint-pnp/Get-PnPDefaultColumnValues.md)** |Gets the default column values for all folders in document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPDefaultColumnValues](../../sharepoint-ps/sharepoint-pnp/Set-PnPDefaultColumnValues.md)** |Sets default column values for a document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPList](../../sharepoint-ps/sharepoint-pnp/Get-PnPList.md)** |Returns a List object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[New-PnPList](../../sharepoint-ps/sharepoint-pnp/New-PnPList.md)** |Creates a new list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPList](../../sharepoint-ps/sharepoint-pnp/Remove-PnPList.md)** |Deletes a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPList](../../sharepoint-ps/sharepoint-pnp/Set-PnPList.md)** |Updates list settings|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPListItem](../../sharepoint-ps/sharepoint-pnp/Add-PnPListItem.md)** |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.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPListItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPListItem.md)** |Retrieves list items|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPListItem](../../sharepoint-ps/sharepoint-pnp/Remove-PnPListItem.md)** |Deletes an item from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPListItem](../../sharepoint-ps/sharepoint-pnp/Set-PnPListItem.md)** |Updates a list item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPListItemPermission](../../sharepoint-ps/sharepoint-pnp/Set-PnPListItemPermission.md)** |Sets list item permissions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Move-PnPListItemToRecycleBin](../../sharepoint-ps/sharepoint-pnp/Move-PnPListItemToRecycleBin.md)** |Moves an item from a list to the Recycle Bin|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPListPermission](../../sharepoint-ps/sharepoint-pnp/Set-PnPListPermission.md)** |Sets list permissions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Request-PnPReIndexList](../../sharepoint-ps/sharepoint-pnp/Request-PnPReIndexList.md)** |Marks the list for full indexing during the next incremental crawl|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPView](../../sharepoint-ps/sharepoint-pnp/Add-PnPView.md)** |Adds a view to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPView](../../sharepoint-ps/sharepoint-pnp/Get-PnPView.md)** |Returns one or all views from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPView](../../sharepoint-ps/sharepoint-pnp/Remove-PnPView.md)** |Deletes a view from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online - -### Microsoft Graph - +**[Clear‑PnPDefaultColumnValues](../../sharepoint-ps/sharepoint-pnp/Clear-PnPDefaultColumnValues.md)** |Clear default column values for a document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPDefaultColumnValues](../../sharepoint-ps/sharepoint-pnp/Get-PnPDefaultColumnValues.md)** |Gets the default column values for all folders in document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPDefaultColumnValues](../../sharepoint-ps/sharepoint-pnp/Set-PnPDefaultColumnValues.md)** |Sets default column values for a document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPFolderPermission](../../sharepoint-ps/sharepoint-pnp/Set-PnPFolderPermission.md)** |Sets folder permissions. Use Get-PnPRoleDefinition to retrieve all available roles you can add or remove using this cmdlet.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPList](../../sharepoint-ps/sharepoint-pnp/Get-PnPList.md)** |Returns a List object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPList](../../sharepoint-ps/sharepoint-pnp/New-PnPList.md)** |Creates a new list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPList](../../sharepoint-ps/sharepoint-pnp/Remove-PnPList.md)** |Deletes a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPList](../../sharepoint-ps/sharepoint-pnp/Set-PnPList.md)** |Updates list settings|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPListItem](../../sharepoint-ps/sharepoint-pnp/Add-PnPListItem.md)** |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.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPListItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPListItem.md)** |Retrieves list items|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPListItem](../../sharepoint-ps/sharepoint-pnp/Remove-PnPListItem.md)** |Deletes an item from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPListItem](../../sharepoint-ps/sharepoint-pnp/Set-PnPListItem.md)** |Updates a list item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPListItemPermission](../../sharepoint-ps/sharepoint-pnp/Set-PnPListItemPermission.md)** |Sets list item permissions. Use Get-PnPRoleDefinition to retrieve all available roles you can add or remove using this cmdlet.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Move‑PnPListItemToRecycleBin](../../sharepoint-ps/sharepoint-pnp/Move-PnPListItemToRecycleBin.md)** |Moves an item from a list to the Recycle Bin|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPListPermission](../../sharepoint-ps/sharepoint-pnp/Set-PnPListPermission.md)** |Sets list permissions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Request‑PnPReIndexList](../../sharepoint-ps/sharepoint-pnp/Request-PnPReIndexList.md)** |Marks the list for full indexing during the next incremental crawl|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPView](../../sharepoint-ps/sharepoint-pnp/Add-PnPView.md)** |Adds a view to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPView](../../sharepoint-ps/sharepoint-pnp/Get-PnPView.md)** |Returns one or all views from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPView](../../sharepoint-ps/sharepoint-pnp/Remove-PnPView.md)** |Deletes a view from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Management API Cmdlet|Description|Platform :-----|:----------|:------- -**[Connect-PnPMicrosoftGraph](../../sharepoint-ps/sharepoint-pnp/Connect-PnPMicrosoftGraph.md)** |Connect to the Microsoft Graph|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteClassification.md)** |Adds one ore more site classification values to the list of possible values. Requires a connection to the Microsoft Graph.|SharePoint Online -**[Disable-PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Disable-PnPSiteClassification.md)** |Disables Site Classifications for the tenant. Requires a connection to the Microsoft Graph.|SharePoint Online -**[Enable-PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Enable-PnPSiteClassification.md)** |Enables Site Classifications for the tenant. Requires a connection to the Microsoft Graph.|SharePoint Online -**[Get-PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteClassification.md)** |Returns the defined Site Classifications for the tenant. Requires a connection to the Microsoft Graph.|SharePoint Online -**[Remove-PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteClassification.md)** |Removes one or more existing site classification values from the list of available values. Requires a connection to the Microsoft Graph|SharePoint Online -**[Update-PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Update-PnPSiteClassification.md)** |Updates Site Classifications for the tenant. Requires a connection to the Microsoft Graph.|SharePoint Online -**[Get-PnPUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroup.md)** |Gets one Office 365 Group (aka Unified Group) or a list of Office 365 Groups|SharePoint Online -**[New-PnPUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/New-PnPUnifiedGroup.md)** |Creates a new Office 365 Group (aka Unified Group)|SharePoint Online -**[Remove-PnPUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/Remove-PnPUnifiedGroup.md)** |Removes one Office 365 Group (aka Unified Group)|SharePoint Online -**[Set-PnPUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/Set-PnPUnifiedGroup.md)** |Sets Office 365 Group (aka Unified Group) properties|SharePoint Online -**[Get-PnPUnifiedGroupMembers](../../sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupMembers.md)** |Gets members of a particular Office 365 Group (aka Unified Group)|SharePoint Online -**[Get-PnPUnifiedGroupOwners](../../sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupOwners.md)** |Gets owners of a particular Office 365 Group (aka Unified Group)|SharePoint Online - -### Provisioning +**[Get‑PnPManagementApiAccessToken](../../sharepoint-ps/sharepoint-pnp/Get-PnPManagementApiAccessToken.md)** |Gets an access token for the Office 365 Management API|SharePoint Online +**[Get‑PnPUnifiedAuditLog](../../sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedAuditLog.md)** |Gets unified audit logs from the Office 365 Management API. Requires the Azure Active Directory application permission 'ActivityFeed.Read'.|SharePoint Online + +### Microsoft Graph Cmdlet|Description|Platform :-----|:----------|:------- -**[Export-PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Export-PnPClientSidePage.md)** |Exports a Client Side Page to a PnP Provisioning Template|SharePoint Online -**[Add-PnPDataRowsToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPDataRowsToProvisioningTemplate.md)** |Adds datarows to a list inside a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPFileFromProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Remove-PnPFileFromProvisioningTemplate.md)** |Removes a file from a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPFileToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPFileToProvisioningTemplate.md)** |Adds a file to a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Convert-PnPFolderToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Convert-PnPFolderToProvisioningTemplate.md)** |Creates a pnp package file of an existing template xml, and includes all files in the current folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPListFoldersToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPListFoldersToProvisioningTemplate.md)** |Adds folders to a list in a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningTemplate.md)** |Adds a PnP Provisioning Template object to a tenant template|SharePoint Online -**[Apply-PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Apply-PnPProvisioningTemplate.md)** |Applies a site template to a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Convert-PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Convert-PnPProvisioningTemplate.md)** |Converts a provisioning template to an other schema version|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplate.md)** |Generates a provisioning site template from a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[New-PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplate.md)** |Creates a new provisioning template object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Read-PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Read-PnPProvisioningTemplate.md)** |Loads/Reads a PnP file from the file system or a string|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Save-PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Save-PnPProvisioningTemplate.md)** |Saves a PnP site template to the file system|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[New-PnPProvisioningTemplateFromFolder](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplateFromFolder.md)** |Generates a provisioning template from a given folder, including only files that are present in that folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPProvisioningTemplateMetadata](../../sharepoint-ps/sharepoint-pnp/Set-PnPProvisioningTemplateMetadata.md)** |Sets metadata of a provisioning template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPTenantSequence](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequence.md)** |Adds a tenant sequence object to a tenant template|SharePoint Online -**[Get-PnPTenantSequence](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequence.md)** |Returns one ore more provisioning sequence object(s) from a tenant template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[New-PnPTenantSequence](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequence.md)** |Creates a new tenant sequence object|SharePoint Online -**[New-PnPTenantSequenceCommunicationSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceCommunicationSite.md)** |Creates a communication site object|SharePoint Online -**[Add-PnPTenantSequenceSite](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSite.md)** |Adds a existing tenant sequence site object to a tenant template|SharePoint Online -**[Get-PnPTenantSequenceSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequenceSite.md)** |Returns one ore more sites from a tenant template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPTenantSequenceSubSite](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSubSite.md)** |Adds a tenant sequence sub site object to a tenant sequence site object|SharePoint Online -**[New-PnPTenantSequenceTeamNoGroupSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSite.md)** |Creates a new team site without an Office 365 group in-memory object|SharePoint Online -**[New-PnPTenantSequenceTeamNoGroupSubSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSubSite.md)** |Creates a team site subsite with no Office 365 group object|SharePoint Online -**[New-PnPTenantSequenceTeamSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamSite.md)** |Creates a team site object|SharePoint Online -**[Apply-PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/Apply-PnPTenantTemplate.md)** |Applies a tenant template to the current tenant. You must be a SharePoint Online global administrator to run the cmdlet.|SharePoint Online -**[New-PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantTemplate.md)** |Creates a new tenant template object|SharePoint Online -**[Read-PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/Read-PnPTenantTemplate.md)** |Loads/Reads a PnP tenant template from the file system and returns an in-memory instance of this template.|SharePoint Online -**[Save-PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/Save-PnPTenantTemplate.md)** |Saves a PnP provisioning hierarchy to the file system|SharePoint Online -**[Test-PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/Test-PnPTenantTemplate.md)** |Tests a tenant template for invalid references|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online - -### Publishing - +**[Get‑PnPDeletedUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/Get-PnPDeletedUnifiedGroup.md)** |Gets one deleted Office 365 Group (aka Unified Group) or a list of deleted Office 365 Groups|SharePoint Online +**[Remove‑PnPDeletedUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/Remove-PnPDeletedUnifiedGroup.md)** |Permanently removes one deleted Office 365 Group (aka Unified Group)|SharePoint Online +**[Restore‑PnPDeletedUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/Restore-PnPDeletedUnifiedGroup.md)** |Restores one deleted Office 365 Group (aka Unified Group)|SharePoint Online +**[Add‑PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteClassification.md)** |Adds one ore more site classification values to the list of possible values. Requires a connection to the Microsoft Graph.|SharePoint Online +**[Disable‑PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Disable-PnPSiteClassification.md)** |Disables Site Classifications for the tenant. Requires a connection to the Microsoft Graph.|SharePoint Online +**[Enable‑PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Enable-PnPSiteClassification.md)** |Enables Site Classifications for the tenant. Requires a connection to the Microsoft Graph.|SharePoint Online +**[Get‑PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteClassification.md)** |Returns the defined Site Classifications for the tenant. Requires a connection to the Microsoft Graph.|SharePoint Online +**[Remove‑PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteClassification.md)** |Removes one or more existing site classification values from the list of available values. Requires a connection to the Microsoft Graph|SharePoint Online +**[Update‑PnPSiteClassification](../../sharepoint-ps/sharepoint-pnp/Update-PnPSiteClassification.md)** |Updates Site Classifications for the tenant. Requires a connection to the Microsoft Graph.|SharePoint Online +**[Get‑PnPUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroup.md)** |Gets one Office 365 Group (aka Unified Group) or a list of Office 365 Groups. Requires the Azure Active Directory application permission 'Group.Read.All'.|SharePoint Online +**[New‑PnPUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/New-PnPUnifiedGroup.md)** |Creates a new Office 365 Group (aka Unified Group). Requires the Azure Active Directory application permission 'Group.ReadWrite.All'.|SharePoint Online +**[Remove‑PnPUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/Remove-PnPUnifiedGroup.md)** |Removes one Office 365 Group (aka Unified Group). Requires the Azure Active Directory application permission 'Group.ReadWrite.All'.|SharePoint Online +**[Set‑PnPUnifiedGroup](../../sharepoint-ps/sharepoint-pnp/Set-PnPUnifiedGroup.md)** |Sets Office 365 Group (aka Unified Group) properties. Requires the Azure Active Directory application permission 'Group.ReadWrite.All'.|SharePoint Online +**[Get‑PnPUnifiedGroupMembers](../../sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupMembers.md)** |Gets members of a particular Office 365 Group (aka Unified Group). Requires the Azure Active Directory application permissions 'Group.Read.All' and 'User.Read.All'.|SharePoint Online +**[Get‑PnPUnifiedGroupOwners](../../sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupOwners.md)** |Gets owners of a particular Office 365 Group (aka Unified Group). Requires the Azure Active Directory application permissions 'Group.Read.All' and 'User.Read.All'.|SharePoint Online + + +### Provisioning Cmdlet|Description|Platform :-----|:----------|:------- -**[Set-PnPAvailablePageLayouts](../../sharepoint-ps/sharepoint-pnp/Set-PnPAvailablePageLayouts.md)** |Sets the available page layouts for the current site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPDefaultPageLayout](../../sharepoint-ps/sharepoint-pnp/Set-PnPDefaultPageLayout.md)** |Sets a specific page layout to be the default page layout for a publishing site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPHtmlPublishingPageLayout](../../sharepoint-ps/sharepoint-pnp/Add-PnPHtmlPublishingPageLayout.md)** |Adds a HTML based publishing page layout|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPMasterPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPMasterPage.md)** |Adds a Masterpage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPPublishingImageRendition](../../sharepoint-ps/sharepoint-pnp/Add-PnPPublishingImageRendition.md)** |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.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPPublishingImageRendition](../../sharepoint-ps/sharepoint-pnp/Get-PnPPublishingImageRendition.md)** |Returns all image renditions or if Identity is specified a specific one|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPPublishingImageRendition](../../sharepoint-ps/sharepoint-pnp/Remove-PnPPublishingImageRendition.md)** |Removes an existing image rendition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPPublishingPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPage.md)** |Adds a publishing page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPPublishingPageLayout](../../sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPageLayout.md)** |Adds a publishing page layout|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPWikiPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPWikiPage.md)** |Adds a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPWikiPage](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWikiPage.md)** |Removes a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPWikiPageContent](../../sharepoint-ps/sharepoint-pnp/Get-PnPWikiPageContent.md)** |Gets the contents/source of a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPWikiPageContent](../../sharepoint-ps/sharepoint-pnp/Set-PnPWikiPageContent.md)** |Sets the contents of a wikipage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online - -### Records Management - +**[Export‑PnPClientSidePage](../../sharepoint-ps/sharepoint-pnp/Export-PnPClientSidePage.md)** |Exports a Client Side Page to a PnP Provisioning Template|SharePoint Online +**[Add‑PnPDataRowsToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPDataRowsToProvisioningTemplate.md)** |Adds datarows to a list inside a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPFileFromProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Remove-PnPFileFromProvisioningTemplate.md)** |Removes a file from a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPFileToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPFileToProvisioningTemplate.md)** |Adds a file to a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Convert‑PnPFolderToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Convert-PnPFolderToProvisioningTemplate.md)** |Creates a pnp package file of an existing template xml, and includes all files in the current folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPListFoldersToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPListFoldersToProvisioningTemplate.md)** |Adds folders to a list in a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Export‑PnPListToProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Export-PnPListToProvisioningTemplate.md)** |Exports one or more lists to provisioning template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningTemplate.md)** |Adds a PnP Provisioning Template object to a tenant template|SharePoint Online +**[Apply‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Apply-PnPProvisioningTemplate.md)** |Applies a site template to a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Convert‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Convert-PnPProvisioningTemplate.md)** |Converts a provisioning template to an other schema version|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplate.md)** |Generates a provisioning site template from a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplate.md)** |Creates a new provisioning template object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Read‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Read-PnPProvisioningTemplate.md)** |Loads/Reads a PnP file from the file system or a string|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Save‑PnPProvisioningTemplate](../../sharepoint-ps/sharepoint-pnp/Save-PnPProvisioningTemplate.md)** |Saves a PnP site template to the file system|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPProvisioningTemplateFromFolder](../../sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplateFromFolder.md)** |Generates a provisioning template from a given folder, including only files that are present in that folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPProvisioningTemplateMetadata](../../sharepoint-ps/sharepoint-pnp/Set-PnPProvisioningTemplateMetadata.md)** |Sets metadata of a provisioning template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPTenantSequence](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequence.md)** |Adds a tenant sequence object to a tenant template|SharePoint Online +**[Get‑PnPTenantSequence](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequence.md)** |Returns one ore more provisioning sequence object(s) from a tenant template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPTenantSequence](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequence.md)** |Creates a new tenant sequence object|SharePoint Online +**[New‑PnPTenantSequenceCommunicationSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceCommunicationSite.md)** |Creates a communication site object|SharePoint Online +**[Add‑PnPTenantSequenceSite](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSite.md)** |Adds a existing tenant sequence site object to a tenant template|SharePoint Online +**[Get‑PnPTenantSequenceSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequenceSite.md)** |Returns one ore more sites from a tenant template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPTenantSequenceSubSite](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSubSite.md)** |Adds a tenant sequence sub site object to a tenant sequence site object|SharePoint Online +**[New‑PnPTenantSequenceTeamNoGroupSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSite.md)** |Creates a new team site without an Office 365 group in-memory object|SharePoint Online +**[New‑PnPTenantSequenceTeamNoGroupSubSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSubSite.md)** |Creates a team site subsite with no Office 365 group object|SharePoint Online +**[New‑PnPTenantSequenceTeamSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamSite.md)** |Creates a team site object|SharePoint Online +**[Apply‑PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/Apply-PnPTenantTemplate.md)** |Applies a tenant template to the current tenant. You must be a SharePoint Online global administrator to run the cmdlet.|SharePoint Online +**[Get‑PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantTemplate.md)** |Generates a provisioning tenant template from a site. If the site is a hubsite any connected site will be included.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantTemplate.md)** |Creates a new tenant template object|SharePoint Online +**[Read‑PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/Read-PnPTenantTemplate.md)** |Loads/Reads a PnP tenant template from the file system and returns an in-memory instance of this template.|SharePoint Online +**[Save‑PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/Save-PnPTenantTemplate.md)** |Saves a PnP provisioning hierarchy to the file system|SharePoint Online +**[Test‑PnPTenantTemplate](../../sharepoint-ps/sharepoint-pnp/Test-PnPTenantTemplate.md)** |Tests a tenant template for invalid references|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Publishing Cmdlet|Description|Platform :-----|:----------|:------- -**[Get-PnPInPlaceRecordsManagement](../../sharepoint-ps/sharepoint-pnp/Get-PnPInPlaceRecordsManagement.md)** |Returns if the place records management feature is enabled.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPInPlaceRecordsManagement](../../sharepoint-ps/sharepoint-pnp/Set-PnPInPlaceRecordsManagement.md)** |Activates or deactivates in the place records management feature.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Disable-PnPInPlaceRecordsManagementForSite](../../sharepoint-ps/sharepoint-pnp/Disable-PnPInPlaceRecordsManagementForSite.md)** |Disables in place records management for a site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Enable-PnPInPlaceRecordsManagementForSite](../../sharepoint-ps/sharepoint-pnp/Enable-PnPInPlaceRecordsManagementForSite.md)** |Enables in place records management for a site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Clear-PnPListItemAsRecord](../../sharepoint-ps/sharepoint-pnp/Clear-PnPListItemAsRecord.md)** |Undeclares a list item as a record|SharePoint Online -**[Set-PnPListItemAsRecord](../../sharepoint-ps/sharepoint-pnp/Set-PnPListItemAsRecord.md)** |Declares a list item as a record, for more information, see https://docs.microsoft.com/sharepoint/governance/records-management-in-sharepoint-server |SharePoint Online -**[Test-PnPListItemIsRecord](../../sharepoint-ps/sharepoint-pnp/Test-PnPListItemIsRecord.md)** |Checks if a list item is a record|SharePoint Online -**[Get-PnPListRecordDeclaration](../../sharepoint-ps/sharepoint-pnp/Get-PnPListRecordDeclaration.md)** |Returns the manual record declaration settings for a list|SharePoint Online -**[Set-PnPListRecordDeclaration](../../sharepoint-ps/sharepoint-pnp/Set-PnPListRecordDeclaration.md)** |The RecordDeclaration parameter supports 4 values: AlwaysAllowManualDeclaration NeverAllowManualDeclaration UseSiteCollectionDefaults |SharePoint Online - -### Search - +**[Set‑PnPAvailablePageLayouts](../../sharepoint-ps/sharepoint-pnp/Set-PnPAvailablePageLayouts.md)** |Sets the available page layouts for the current site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPDefaultPageLayout](../../sharepoint-ps/sharepoint-pnp/Set-PnPDefaultPageLayout.md)** |Sets a specific page layout to be the default page layout for a publishing site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPHtmlPublishingPageLayout](../../sharepoint-ps/sharepoint-pnp/Add-PnPHtmlPublishingPageLayout.md)** |Adds a HTML based publishing page layout|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPMasterPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPMasterPage.md)** |Adds a Masterpage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPPublishingImageRendition](../../sharepoint-ps/sharepoint-pnp/Add-PnPPublishingImageRendition.md)** |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.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPPublishingImageRendition](../../sharepoint-ps/sharepoint-pnp/Get-PnPPublishingImageRendition.md)** |Returns all image renditions or if Identity is specified a specific one|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPPublishingImageRendition](../../sharepoint-ps/sharepoint-pnp/Remove-PnPPublishingImageRendition.md)** |Removes an existing image rendition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPPublishingPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPage.md)** |Adds a publishing page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPPublishingPageLayout](../../sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPageLayout.md)** |Adds a publishing page layout|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPWikiPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPWikiPage.md)** |Adds a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPWikiPage](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWikiPage.md)** |Removes a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPWikiPageContent](../../sharepoint-ps/sharepoint-pnp/Get-PnPWikiPageContent.md)** |Gets the contents/source of a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPWikiPageContent](../../sharepoint-ps/sharepoint-pnp/Set-PnPWikiPageContent.md)** |Sets the contents of a wikipage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Records Management +Cmdlet|Description|Platform +:-----|:----------|:------- +**[Get‑PnPInPlaceRecordsManagement](../../sharepoint-ps/sharepoint-pnp/Get-PnPInPlaceRecordsManagement.md)** |Returns if the place records management feature is enabled.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPInPlaceRecordsManagement](../../sharepoint-ps/sharepoint-pnp/Set-PnPInPlaceRecordsManagement.md)** |Activates or deactivates in the place records management feature.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Disable‑PnPInPlaceRecordsManagementForSite](../../sharepoint-ps/sharepoint-pnp/Disable-PnPInPlaceRecordsManagementForSite.md)** |Disables in place records management for a site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Enable‑PnPInPlaceRecordsManagementForSite](../../sharepoint-ps/sharepoint-pnp/Enable-PnPInPlaceRecordsManagementForSite.md)** |Enables in place records management for a site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Clear‑PnPListItemAsRecord](../../sharepoint-ps/sharepoint-pnp/Clear-PnPListItemAsRecord.md)** |Undeclares a list item as a record|SharePoint Online +**[Set‑PnPListItemAsRecord](../../sharepoint-ps/sharepoint-pnp/Set-PnPListItemAsRecord.md)** |Declares a list item as a record, for more information, see https://docs.microsoft.com/sharepoint/governance/records-management-in-sharepoint-server|SharePoint Online +**[Test‑PnPListItemIsRecord](../../sharepoint-ps/sharepoint-pnp/Test-PnPListItemIsRecord.md)** |Checks if a list item is a record|SharePoint Online +**[Get‑PnPListRecordDeclaration](../../sharepoint-ps/sharepoint-pnp/Get-PnPListRecordDeclaration.md)** |Returns the manual record declaration settings for a list|SharePoint Online +**[Set‑PnPListRecordDeclaration](../../sharepoint-ps/sharepoint-pnp/Set-PnPListRecordDeclaration.md)** |The RecordDeclaration parameter supports 4 values: AlwaysAllowManualDeclaration NeverAllowManualDeclaration UseSiteCollectionDefaults |SharePoint Online + + +### Search Cmdlet|Description|Platform :-----|:----------|:------- -**[Get-PnPSearchConfiguration](../../sharepoint-ps/sharepoint-pnp/Get-PnPSearchConfiguration.md)** |Returns the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPSearchConfiguration](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSearchConfiguration.md)** |Remove the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPSearchConfiguration](../../sharepoint-ps/sharepoint-pnp/Set-PnPSearchConfiguration.md)** |Sets the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPSearchCrawlLog](../../sharepoint-ps/sharepoint-pnp/Get-PnPSearchCrawlLog.md)** |Returns entries from the SharePoint search crawl log|SharePoint Online -**[Submit-PnPSearchQuery](../../sharepoint-ps/sharepoint-pnp/Submit-PnPSearchQuery.md)** |Executes an arbitrary search query against the SharePoint search index|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPSiteSearchQueryResults](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteSearchQueryResults.md)** |Executes a search query to retrieve indexed site collections|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPSearchConfiguration](../../sharepoint-ps/sharepoint-pnp/Get-PnPSearchConfiguration.md)** |Returns the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPSearchConfiguration](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSearchConfiguration.md)** |Remove the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPSearchConfiguration](../../sharepoint-ps/sharepoint-pnp/Set-PnPSearchConfiguration.md)** |Sets the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPSearchCrawlLog](../../sharepoint-ps/sharepoint-pnp/Get-PnPSearchCrawlLog.md)** |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://-admin.sharepoint.com/_layouts/15/searchadmin/crawllogreadpermission.aspx in order to run this cmdlet.|SharePoint Online +**[Submit‑PnPSearchQuery](../../sharepoint-ps/sharepoint-pnp/Submit-PnPSearchQuery.md)** |Executes an arbitrary search query against the SharePoint search index|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPSearchSettings](../../sharepoint-ps/sharepoint-pnp/Get-PnPSearchSettings.md)** |Retrieves search settings for a site|SharePoint Online +**[Set‑PnPSearchSettings](../../sharepoint-ps/sharepoint-pnp/Set-PnPSearchSettings.md)** |Sets search settings for a site|SharePoint Online +**[Get‑PnPSiteSearchQueryResults](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteSearchQueryResults.md)** |Executes a search query to retrieve indexed site collections|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -### SharePoint Recycle Bin +### SharePoint Recycle Bin Cmdlet|Description|Platform :-----|:----------|:------- -**[Clear-PnPRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Clear-PnPRecycleBinItem.md)** |Permanently deletes all or a specific recycle bin item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPRecycleBinItem.md)** |Returns the items in the recycle bin from the context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Move-PnPRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Move-PnPRecycleBinItem.md)** |Moves all items or a specific item in the first stage recycle bin of the current site collection to the second stage recycle bin|SharePoint Online -**[Restore-PnPRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Restore-PnPRecycleBinItem.md)** |Restores the provided recycle bin item to its original location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPTenantRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantRecycleBinItem.md)** |Returns all modern and classic site collections in the tenant scoped recycle bin|SharePoint Online +**[Clear‑PnPRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Clear-PnPRecycleBinItem.md)** |Permanently deletes all or a specific recycle bin item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPRecycleBinItem.md)** |Returns the items in the recycle bin from the context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Move‑PnPRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Move-PnPRecycleBinItem.md)** |Moves all items or a specific item in the first stage recycle bin of the current site collection to the second stage recycle bin|SharePoint Online +**[Restore‑PnPRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Restore-PnPRecycleBinItem.md)** |Restores the provided recycle bin item to its original location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPTenantRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantRecycleBinItem.md)** |Returns all modern and classic site collections in the tenant scoped recycle bin|SharePoint Online -### SharePoint WebHooks +### SharePoint WebHooks Cmdlet|Description|Platform :-----|:----------|:------- -**[Add-PnPWebhookSubscription](../../sharepoint-ps/sharepoint-pnp/Add-PnPWebhookSubscription.md)** |Adds a new Webhook subscription|SharePoint Online -**[Remove-PnPWebhookSubscription](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWebhookSubscription.md)** |Removes a Webhook subscription from the resource|SharePoint Online -**[Set-PnPWebhookSubscription](../../sharepoint-ps/sharepoint-pnp/Set-PnPWebhookSubscription.md)** |Updates a Webhook subscription|SharePoint Online -**[Get-PnPWebhookSubscriptions](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebhookSubscriptions.md)** |Gets all the Webhook subscriptions of the resource|SharePoint Online +**[Add‑PnPWebhookSubscription](../../sharepoint-ps/sharepoint-pnp/Add-PnPWebhookSubscription.md)** |Adds a new Webhook subscription|SharePoint Online +**[Remove‑PnPWebhookSubscription](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWebhookSubscription.md)** |Removes a Webhook subscription from the resource|SharePoint Online +**[Set‑PnPWebhookSubscription](../../sharepoint-ps/sharepoint-pnp/Set-PnPWebhookSubscription.md)** |Updates a Webhook subscription|SharePoint Online +**[Get‑PnPWebhookSubscriptions](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebhookSubscriptions.md)** |Gets all the Webhook subscriptions of the resource|SharePoint Online -### Sites +### Sites Cmdlet|Description|Platform :-----|:----------|:------- -**[Set-PnPAppSideLoading](../../sharepoint-ps/sharepoint-pnp/Set-PnPAppSideLoading.md)** |Enables the App SideLoading Feature on a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPAuditing](../../sharepoint-ps/sharepoint-pnp/Get-PnPAuditing.md)** |Get the Auditing setting of a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPAuditing](../../sharepoint-ps/sharepoint-pnp/Set-PnPAuditing.md)** |Set Auditing setting for a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Test-PnPOffice365GroupAliasIsUsed](../../sharepoint-ps/sharepoint-pnp/Test-PnPOffice365GroupAliasIsUsed.md)** |Tests if a given alias is already used used|SharePoint Online -**[Add-PnPRoleDefinition](../../sharepoint-ps/sharepoint-pnp/Add-PnPRoleDefinition.md)** |Adds a Role Defintion (Permission Level) to the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPRoleDefinition](../../sharepoint-ps/sharepoint-pnp/Get-PnPRoleDefinition.md)** |Retrieves a Role Definitions of a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPRoleDefinition](../../sharepoint-ps/sharepoint-pnp/Remove-PnPRoleDefinition.md)** |Remove a Role Definition from a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPSite.md)** |Returns the current site collection from the context.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPSite](../../sharepoint-ps/sharepoint-pnp/Set-PnPSite.md)** |Sets Site Collection properties.|SharePoint Online -**[Add-PnPSiteCollectionAdmin](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAdmin.md)** |Adds one or more users as site collection administrators to the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPSiteCollectionAdmin](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionAdmin.md)** |Returns the current site collection administrators of the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPSiteCollectionAdmin](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAdmin.md)** |Removes one or more users as site collection administrators from the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Install-PnPSolution](../../sharepoint-ps/sharepoint-pnp/Install-PnPSolution.md)** |Installs a sandboxed solution to a site collection. WARNING! This method can delete your composed look gallery due to the method used to activate the solution. We recommend you to only to use this cmdlet if you are okay with that.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Uninstall-PnPSolution](../../sharepoint-ps/sharepoint-pnp/Uninstall-PnPSolution.md)** |Uninstalls a sandboxed solution from a site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online - -### Taxonomy - +**[Set‑PnPAppSideLoading](../../sharepoint-ps/sharepoint-pnp/Set-PnPAppSideLoading.md)** |Enables the App SideLoading Feature on a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPAuditing](../../sharepoint-ps/sharepoint-pnp/Get-PnPAuditing.md)** |Get the Auditing setting of a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPAuditing](../../sharepoint-ps/sharepoint-pnp/Set-PnPAuditing.md)** |Set Auditing setting for a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Test‑PnPOffice365GroupAliasIsUsed](../../sharepoint-ps/sharepoint-pnp/Test-PnPOffice365GroupAliasIsUsed.md)** |Tests if a given alias is already used used|SharePoint Online +**[Add‑PnPRoleDefinition](../../sharepoint-ps/sharepoint-pnp/Add-PnPRoleDefinition.md)** |Adds a Role Defintion (Permission Level) to the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPRoleDefinition](../../sharepoint-ps/sharepoint-pnp/Get-PnPRoleDefinition.md)** |Retrieves a Role Definitions of a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPRoleDefinition](../../sharepoint-ps/sharepoint-pnp/Remove-PnPRoleDefinition.md)** |Remove a Role Definition from a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPSite.md)** |Returns the current site collection from the context.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPSite](../../sharepoint-ps/sharepoint-pnp/Set-PnPSite.md)** |Sets Site Collection properties.|SharePoint Online +**[Add‑PnPSiteCollectionAdmin](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAdmin.md)** |Adds one or more users as site collection administrators to the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPSiteCollectionAdmin](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionAdmin.md)** |Returns the current site collection administrators of the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPSiteCollectionAdmin](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAdmin.md)** |Removes one or more users as site collection administrators from the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Install‑PnPSolution](../../sharepoint-ps/sharepoint-pnp/Install-PnPSolution.md)** |Installs a sandboxed solution to a site collection. WARNING! This method can delete your composed look gallery due to the method used to activate the solution. We recommend you to only to use this cmdlet if you are okay with that.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Uninstall‑PnPSolution](../../sharepoint-ps/sharepoint-pnp/Uninstall-PnPSolution.md)** |Uninstalls a sandboxed solution from a site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPTeamsTeam](../../sharepoint-ps/sharepoint-pnp/Add-PnPTeamsTeam.md)** |Adds a Teams team to an existing, group connected, site collection|SharePoint Online + + +### Taxonomy Cmdlet|Description|Platform :-----|:----------|:------- -**[Get-PnPSiteCollectionTermStore](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionTermStore.md)** |Returns the site collection term store|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Export-PnPTaxonomy](../../sharepoint-ps/sharepoint-pnp/Export-PnPTaxonomy.md)** |Exports a taxonomy to either the output or to a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Import-PnPTaxonomy](../../sharepoint-ps/sharepoint-pnp/Import-PnPTaxonomy.md)** |Imports a taxonomy from either a string array or a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPTaxonomyFieldValue](../../sharepoint-ps/sharepoint-pnp/Set-PnPTaxonomyFieldValue.md)** |Sets a taxonomy term value in a listitem field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPTaxonomyItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomyItem.md)** |Returns a taxonomy item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPTaxonomyItem](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTaxonomyItem.md)** |Removes a taxonomy item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPTaxonomySession](../../sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomySession.md)** |Returns a taxonomy session|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPTerm](../../sharepoint-ps/sharepoint-pnp/Get-PnPTerm.md)** |Returns a taxonomy term|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[New-PnPTerm](../../sharepoint-ps/sharepoint-pnp/New-PnPTerm.md)** |Creates a taxonomy term|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPTermGroup](../../sharepoint-ps/sharepoint-pnp/Get-PnPTermGroup.md)** |Returns a taxonomy term group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[New-PnPTermGroup](../../sharepoint-ps/sharepoint-pnp/New-PnPTermGroup.md)** |Creates a taxonomy term group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPTermGroup](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTermGroup.md)** |Removes a taxonomy term group and all its containing termsets|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Import-PnPTermGroupFromXml](../../sharepoint-ps/sharepoint-pnp/Import-PnPTermGroupFromXml.md)** |Imports a taxonomy TermGroup from either the input or from an XML file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Export-PnPTermGroupToXml](../../sharepoint-ps/sharepoint-pnp/Export-PnPTermGroupToXml.md)** |Exports a taxonomy TermGroup to either the output or to an XML file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPTermSet](../../sharepoint-ps/sharepoint-pnp/Get-PnPTermSet.md)** |Returns a taxonomy term set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Import-PnPTermSet](../../sharepoint-ps/sharepoint-pnp/Import-PnPTermSet.md)** |Imports a taxonomy term set from a file in the standard format.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[New-PnPTermSet](../../sharepoint-ps/sharepoint-pnp/New-PnPTermSet.md)** |Creates a taxonomy term set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online - -### Tenant Administration - +**[Get‑PnPSiteCollectionTermStore](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionTermStore.md)** |Returns the site collection term store|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Export‑PnPTaxonomy](../../sharepoint-ps/sharepoint-pnp/Export-PnPTaxonomy.md)** |Exports a taxonomy to either the output or to a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Import‑PnPTaxonomy](../../sharepoint-ps/sharepoint-pnp/Import-PnPTaxonomy.md)** |Imports a taxonomy from either a string array or a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPTaxonomyFieldValue](../../sharepoint-ps/sharepoint-pnp/Set-PnPTaxonomyFieldValue.md)** |Sets a taxonomy term value in a listitem field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPTaxonomyItem](../../sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomyItem.md)** |Returns a taxonomy item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPTaxonomyItem](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTaxonomyItem.md)** |Removes a taxonomy item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPTaxonomySession](../../sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomySession.md)** |Returns a taxonomy session|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPTerm](../../sharepoint-ps/sharepoint-pnp/Get-PnPTerm.md)** |Returns a taxonomy term|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPTerm](../../sharepoint-ps/sharepoint-pnp/New-PnPTerm.md)** |Creates a taxonomy term|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPTermGroup](../../sharepoint-ps/sharepoint-pnp/Get-PnPTermGroup.md)** |Returns a taxonomy term group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPTermGroup](../../sharepoint-ps/sharepoint-pnp/New-PnPTermGroup.md)** |Creates a taxonomy term group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPTermGroup](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTermGroup.md)** |Removes a taxonomy term group and all its containing termsets|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Import‑PnPTermGroupFromXml](../../sharepoint-ps/sharepoint-pnp/Import-PnPTermGroupFromXml.md)** |Imports a taxonomy TermGroup from either the input or from an XML file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Export‑PnPTermGroupToXml](../../sharepoint-ps/sharepoint-pnp/Export-PnPTermGroupToXml.md)** |Exports a taxonomy TermGroup to either the output or to an XML file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPTermSet](../../sharepoint-ps/sharepoint-pnp/Get-PnPTermSet.md)** |Returns a taxonomy term set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Import‑PnPTermSet](../../sharepoint-ps/sharepoint-pnp/Import-PnPTermSet.md)** |Imports a taxonomy term set from a file in the standard format.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPTermSet](../../sharepoint-ps/sharepoint-pnp/New-PnPTermSet.md)** |Creates a taxonomy term set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Tenant Administration Cmdlet|Description|Platform :-----|:----------|:------- -**[Get-PnPAccessToken](../../sharepoint-ps/sharepoint-pnp/Get-PnPAccessToken.md)** |Returns the current OAuth Access token|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Enable-PnPCommSite](../../sharepoint-ps/sharepoint-pnp/Enable-PnPCommSite.md)** |Enable communication site on the root site of a tenant|SharePoint Online -**[Get-PnPHideDefaultThemes](../../sharepoint-ps/sharepoint-pnp/Get-PnPHideDefaultThemes.md)** |Returns if the default / OOTB themes should be visible to users or not.|SharePoint Online -**[Set-PnPHideDefaultThemes](../../sharepoint-ps/sharepoint-pnp/Set-PnPHideDefaultThemes.md)** |Defines if the default / OOTB themes should be visible to users or not.|SharePoint Online -**[Get-PnPHomeSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPHomeSite.md)** |Returns the home site url for your tenant|SharePoint Online -**[Remove-PnPHomeSite](../../sharepoint-ps/sharepoint-pnp/Remove-PnPHomeSite.md)** |Removes the currently set site as the home site|SharePoint Online -**[Set-PnPHomeSite](../../sharepoint-ps/sharepoint-pnp/Set-PnPHomeSite.md)** |Sets the home site for your tenant|SharePoint Online -**[Get-PnPHubSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPHubSite.md)** |Retrieve all or a specific hubsite.|SharePoint Online -**[Register-PnPHubSite](../../sharepoint-ps/sharepoint-pnp/Register-PnPHubSite.md)** |Registers a site as a hubsite|SharePoint Online -**[Set-PnPHubSite](../../sharepoint-ps/sharepoint-pnp/Set-PnPHubSite.md)** |Sets hubsite properties|SharePoint Online -**[Unregister-PnPHubSite](../../sharepoint-ps/sharepoint-pnp/Unregister-PnPHubSite.md)** |Unregisters a site as a hubsite|SharePoint Online -**[Add-PnPHubSiteAssociation](../../sharepoint-ps/sharepoint-pnp/Add-PnPHubSiteAssociation.md)** |Connects a site to a hubsite.|SharePoint Online -**[Remove-PnPHubSiteAssociation](../../sharepoint-ps/sharepoint-pnp/Remove-PnPHubSiteAssociation.md)** |Disconnects a site from a hubsite.|SharePoint Online -**[Grant-PnPHubSiteRights](../../sharepoint-ps/sharepoint-pnp/Grant-PnPHubSiteRights.md)** |Grant additional permissions to the permissions already in place to associate sites to Hub Sites for one or more specific users|SharePoint Online -**[Add-PnPOffice365GroupToSite](../../sharepoint-ps/sharepoint-pnp/Add-PnPOffice365GroupToSite.md)** |Groupifies a classic team site by creating an Office 365 group for it and connecting the site with the newly created group|SharePoint Online -**[Disable-PnPPowerShellTelemetry](../../sharepoint-ps/sharepoint-pnp/Disable-PnPPowerShellTelemetry.md)** |Disables PnP PowerShell telemetry tracking|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Enable-PnPPowerShellTelemetry](../../sharepoint-ps/sharepoint-pnp/Enable-PnPPowerShellTelemetry.md)** |Enables PnP PowerShell telemetry tracking.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPPowerShellTelemetryEnabled](../../sharepoint-ps/sharepoint-pnp/Get-PnPPowerShellTelemetryEnabled.md)** |Returns true if the PnP PowerShell Telemetry has been enabled.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[New-PnPSite](../../sharepoint-ps/sharepoint-pnp/New-PnPSite.md)** |Creates a new site collection|SharePoint Online -**[Add-PnPSiteCollectionAppCatalog](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAppCatalog.md)** |Adds a Site Collection scoped App Catalog to a site|SharePoint Online -**[Remove-PnPSiteCollectionAppCatalog](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAppCatalog.md)** |Removes a Site Collection scoped App Catalog from a site|SharePoint Online -**[Add-PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesign.md)** |Creates a new Site Design on the current tenant.|SharePoint Online -**[Get-PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesign.md)** |Retrieve Site Designs that have been registered on the current tenant.|SharePoint Online -**[Invoke-PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Invoke-PnPSiteDesign.md)** |Apply a Site Design to an existing site. * Requires Tenant Administration Rights *|SharePoint Online -**[Remove-PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesign.md)** |Removes a Site Design|SharePoint Online -**[Set-PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Set-PnPSiteDesign.md)** |Updates a Site Design on the current tenant.|SharePoint Online -**[Get-PnPSiteDesignRights](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRights.md)** |Returns the principals with design rights on a specific Site Design|SharePoint Online -**[Grant-PnPSiteDesignRights](../../sharepoint-ps/sharepoint-pnp/Grant-PnPSiteDesignRights.md)** |Grants the specified principals rights to use the site design.|SharePoint Online -**[Revoke-PnPSiteDesignRights](../../sharepoint-ps/sharepoint-pnp/Revoke-PnPSiteDesignRights.md)** |Revokes the specified principals rights to use the site design.|SharePoint Online -**[Get-PnPSiteDesignRun](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRun.md)** |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.|SharePoint Online -**[Get-PnPSiteDesignRunStatus](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRunStatus.md)** |Retrieves and displays a list of all site script actions executed for a specified site design applied to a site.|SharePoint Online -**[Add-PnPSiteDesignTask](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesignTask.md)** |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.|SharePoint Online -**[Get-PnPSiteDesignTask](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignTask.md)** |Used to retrieve a scheduled site design script. It takes the ID of the scheduled site design and the URL for the site where the site design is scheduled to be applied. |SharePoint Online -**[Remove-PnPSiteDesignTask](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesignTask.md)** |Removes a Site Design Task. If the execution of the associated site script has already started the execution will not be terminated.|SharePoint Online -**[Add-PnPSiteScript](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteScript.md)** |Creates a new Site Script on the current tenant.|SharePoint Online -**[Get-PnPSiteScript](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteScript.md)** |Retrieve Site Scripts that have been registered on the current tenant.|SharePoint Online -**[Remove-PnPSiteScript](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteScript.md)** |Removes a Site Script|SharePoint Online -**[Set-PnPSiteScript](../../sharepoint-ps/sharepoint-pnp/Set-PnPSiteScript.md)** |Updates an existing Site Script on the current tenant.|SharePoint Online -**[Get-PnPStorageEntity](../../sharepoint-ps/sharepoint-pnp/Get-PnPStorageEntity.md)** |Retrieve Storage Entities / Farm Properties from either the Tenant App Catalog or from the current site if it has a site scope app catalog.|SharePoint Online -**[Remove-PnPStorageEntity](../../sharepoint-ps/sharepoint-pnp/Remove-PnPStorageEntity.md)** |Remove Storage Entities / Farm Properties from either the tenant scoped app catalog or the current site collection if the site has a site collection scoped app catalog|SharePoint Online -**[Set-PnPStorageEntity](../../sharepoint-ps/sharepoint-pnp/Set-PnPStorageEntity.md)** |Set Storage Entities / Farm Properties in either the tenant scoped app catalog or the site collection app catalog.|SharePoint Online -**[Get-PnPTenant](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenant.md)** |Returns organization-level site collection properties|SharePoint Online -**[Set-PnPTenant](../../sharepoint-ps/sharepoint-pnp/Set-PnPTenant.md)** |Sets organization-level site collection properties|SharePoint Online -**[Get-PnPTenantAppCatalogUrl](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantAppCatalogUrl.md)** |Retrieves the url of the tenant scoped app catalog.|SharePoint Online -**[Get-PnPTenantCdnEnabled](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnEnabled.md)** |Retrieves if the Office 365 Content Delivery Network has been enabled.|SharePoint Online -**[Set-PnPTenantCdnEnabled](../../sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnEnabled.md)** |Enables or disabled the public or private Office 365 Content Delivery Network (CDN).|SharePoint Online -**[Add-PnPTenantCdnOrigin](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantCdnOrigin.md)** |Adds a new origin to the public or private content delivery network (CDN).|SharePoint Online -**[Get-PnPTenantCdnOrigin](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnOrigin.md)** |Returns the current registered origins from the public or private content delivery network (CDN).|SharePoint Online -**[Remove-PnPTenantCdnOrigin](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTenantCdnOrigin.md)** |Removes an origin from the Public or Private content delivery network (CDN).|SharePoint Online -**[Get-PnPTenantCdnPolicies](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnPolicies.md)** |Returns the CDN Policies for the specified CDN (Public | Private).|SharePoint Online -**[Set-PnPTenantCdnPolicy](../../sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnPolicy.md)** |Sets the CDN Policies for the specified CDN (Public | Private).|SharePoint Online -**[Clear-PnPTenantRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Clear-PnPTenantRecycleBinItem.md)** |Permanently deletes a site collection from the tenant scoped recycle bin|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Restore-PnPTenantRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Restore-PnPTenantRecycleBinItem.md)** |Restores a site collection from the tenant scoped recycle bin|SharePoint Online -**[Disable-PnPTenantServicePrincipal](../../sharepoint-ps/sharepoint-pnp/Disable-PnPTenantServicePrincipal.md)** |Enables the current tenant's "SharePoint Online Client" service principal.|SharePoint Online -**[Enable-PnPTenantServicePrincipal](../../sharepoint-ps/sharepoint-pnp/Enable-PnPTenantServicePrincipal.md)** |Enables the current tenant's "SharePoint Online Client" service principal.|SharePoint Online -**[Get-PnPTenantServicePrincipal](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipal.md)** |Returns the current tenant's "SharePoint Online Client" service principal.|SharePoint Online -**[Revoke-PnPTenantServicePrincipalPermission](../../sharepoint-ps/sharepoint-pnp/Revoke-PnPTenantServicePrincipalPermission.md)** |Revokes a permission that was previously granted to the "SharePoint Online Client" service principal.|SharePoint Online -**[Get-PnPTenantServicePrincipalPermissionGrants](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionGrants.md)** |Gets the collection of permission grants for the "SharePoint Online Client" service principal|SharePoint Online -**[Approve-PnPTenantServicePrincipalPermissionRequest](../../sharepoint-ps/sharepoint-pnp/Approve-PnPTenantServicePrincipalPermissionRequest.md)** |Approves a permission request for the current tenant's "SharePoint Online Client" service principal|SharePoint Online -**[Deny-PnPTenantServicePrincipalPermissionRequest](../../sharepoint-ps/sharepoint-pnp/Deny-PnPTenantServicePrincipalPermissionRequest.md)** |Denies a permission request for the current tenant's "SharePoint Online Client" service principal|SharePoint Online -**[Get-PnPTenantServicePrincipalPermissionRequests](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionRequests.md)** |Gets the collection of permission requests for the "SharePoint Online Client" service principal|SharePoint Online -**[Get-PnPTenantSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantSite.md)** |Retrieve site information.|SharePoint Online -**[New-PnPTenantSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSite.md)** |Creates a new site collection for the current tenant|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPTenantSite](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTenantSite.md)** |Removes a site collection|SharePoint Online -**[Set-PnPTenantSite](../../sharepoint-ps/sharepoint-pnp/Set-PnPTenantSite.md)** |Set site information.|SharePoint Online -**[Add-PnPTenantTheme](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantTheme.md)** |Adds or updates a theme to the tenant.|SharePoint Online -**[Get-PnPTenantTheme](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantTheme.md)** |Returns all or a specific theme|SharePoint Online -**[Remove-PnPTenantTheme](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTenantTheme.md)** |Removes a theme|SharePoint Online -**[Get-PnPTimeZoneId](../../sharepoint-ps/sharepoint-pnp/Get-PnPTimeZoneId.md)** |Returns a time zone ID|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPWebTemplates](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebTemplates.md)** |Returns the available web templates.|SharePoint Online - -### User and group management - +**[Get‑PnPAccessToken](../../sharepoint-ps/sharepoint-pnp/Get-PnPAccessToken.md)** |Returns the current OAuth Access token|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Enable‑PnPCommSite](../../sharepoint-ps/sharepoint-pnp/Enable-PnPCommSite.md)** |Enable communication site on the root site of a tenant|SharePoint Online +**[Get‑PnPHideDefaultThemes](../../sharepoint-ps/sharepoint-pnp/Get-PnPHideDefaultThemes.md)** |Returns if the default / OOTB themes should be visible to users or not.|SharePoint Online +**[Set‑PnPHideDefaultThemes](../../sharepoint-ps/sharepoint-pnp/Set-PnPHideDefaultThemes.md)** |Defines if the default / OOTB themes should be visible to users or not.|SharePoint Online +**[Get‑PnPHomeSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPHomeSite.md)** |Returns the home site url for your tenant|SharePoint Online +**[Remove‑PnPHomeSite](../../sharepoint-ps/sharepoint-pnp/Remove-PnPHomeSite.md)** |Removes the currently set site as the home site|SharePoint Online +**[Set‑PnPHomeSite](../../sharepoint-ps/sharepoint-pnp/Set-PnPHomeSite.md)** |Sets the home site for your tenant|SharePoint Online +**[Get‑PnPHubSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPHubSite.md)** |Retrieve all or a specific hubsite.|SharePoint Online +**[Register‑PnPHubSite](../../sharepoint-ps/sharepoint-pnp/Register-PnPHubSite.md)** |Registers a site as a hubsite|SharePoint Online +**[Set‑PnPHubSite](../../sharepoint-ps/sharepoint-pnp/Set-PnPHubSite.md)** |Sets hub site properties|SharePoint Online +**[Unregister‑PnPHubSite](../../sharepoint-ps/sharepoint-pnp/Unregister-PnPHubSite.md)** |Unregisters a site as a hubsite|SharePoint Online +**[Add‑PnPHubSiteAssociation](../../sharepoint-ps/sharepoint-pnp/Add-PnPHubSiteAssociation.md)** |Connects a site to a hubsite.|SharePoint Online +**[Remove‑PnPHubSiteAssociation](../../sharepoint-ps/sharepoint-pnp/Remove-PnPHubSiteAssociation.md)** |Disconnects a site from a hubsite.|SharePoint Online +**[Get‑PnPHubSiteChild](../../sharepoint-ps/sharepoint-pnp/Get-PnPHubSiteChild.md)** |Retrieves all sites linked to a specific hub site|SharePoint Online +**[Grant‑PnPHubSiteRights](../../sharepoint-ps/sharepoint-pnp/Grant-PnPHubSiteRights.md)** |Grant additional permissions to the permissions already in place to associate sites to Hub Sites for one or more specific users|SharePoint Online +**[Add‑PnPOffice365GroupToSite](../../sharepoint-ps/sharepoint-pnp/Add-PnPOffice365GroupToSite.md)** |Groupifies a classic team site by creating an Office 365 group for it and connecting the site with the newly created group|SharePoint Online +**[Add‑PnPOrgAssetsLibrary](../../sharepoint-ps/sharepoint-pnp/Add-PnPOrgAssetsLibrary.md)** |Adds a given document library as a organizational asset source|SharePoint Online +**[Get‑PnPOrgAssetsLibrary](../../sharepoint-ps/sharepoint-pnp/Get-PnPOrgAssetsLibrary.md)** |Returns the list of all the configured organizational asset libraries|SharePoint Online +**[Remove‑PnPOrgAssetsLibrary](../../sharepoint-ps/sharepoint-pnp/Remove-PnPOrgAssetsLibrary.md)** |Removes a given document library as a organizational asset source|SharePoint Online +**[Add‑PnPOrgNewsSite](../../sharepoint-ps/sharepoint-pnp/Add-PnPOrgNewsSite.md)** |Adds the site as an organization news source in your tenant|SharePoint Online +**[Get‑PnPOrgNewsSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPOrgNewsSite.md)** |Returns the list of all the configured organizational news sites.|SharePoint Online +**[Remove‑PnPOrgNewsSite](../../sharepoint-ps/sharepoint-pnp/Remove-PnPOrgNewsSite.md)** |Removes a given site from the list of organizational news sites.|SharePoint Online +**[Disable‑PnPPowerShellTelemetry](../../sharepoint-ps/sharepoint-pnp/Disable-PnPPowerShellTelemetry.md)** |Disables PnP PowerShell telemetry tracking|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Enable‑PnPPowerShellTelemetry](../../sharepoint-ps/sharepoint-pnp/Enable-PnPPowerShellTelemetry.md)** |Enables PnP PowerShell telemetry tracking.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPPowerShellTelemetryEnabled](../../sharepoint-ps/sharepoint-pnp/Get-PnPPowerShellTelemetryEnabled.md)** |Returns true if the PnP PowerShell Telemetry has been enabled.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPSite](../../sharepoint-ps/sharepoint-pnp/New-PnPSite.md)** |Creates either a communication site or an Office 365 group-connected team site|SharePoint Online +**[Add‑PnPSiteCollectionAppCatalog](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAppCatalog.md)** |Adds a Site Collection scoped App Catalog to a site|SharePoint Online +**[Remove‑PnPSiteCollectionAppCatalog](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAppCatalog.md)** |Removes a Site Collection scoped App Catalog from a site|SharePoint Online +**[Add‑PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesign.md)** |Creates a new Site Design on the current tenant.|SharePoint Online +**[Get‑PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesign.md)** |Retrieve Site Designs that have been registered on the current tenant.|SharePoint Online +**[Invoke‑PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Invoke-PnPSiteDesign.md)** |Apply a Site Design to an existing site. * Requires Tenant Administration Rights *|SharePoint Online +**[Remove‑PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesign.md)** |Removes a Site Design|SharePoint Online +**[Set‑PnPSiteDesign](../../sharepoint-ps/sharepoint-pnp/Set-PnPSiteDesign.md)** |Updates a Site Design on the current tenant.|SharePoint Online +**[Get‑PnPSiteDesignRights](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRights.md)** |Returns the principals with design rights on a specific Site Design|SharePoint Online +**[Grant‑PnPSiteDesignRights](../../sharepoint-ps/sharepoint-pnp/Grant-PnPSiteDesignRights.md)** |Grants the specified principals rights to use the site design.|SharePoint Online +**[Revoke‑PnPSiteDesignRights](../../sharepoint-ps/sharepoint-pnp/Revoke-PnPSiteDesignRights.md)** |Revokes the specified principals rights to use the site design.|SharePoint Online +**[Get‑PnPSiteDesignRun](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRun.md)** |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.|SharePoint Online +**[Get‑PnPSiteDesignRunStatus](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRunStatus.md)** |Retrieves and displays a list of all site script actions executed for a specified site design applied to a site.|SharePoint Online +**[Add‑PnPSiteDesignTask](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesignTask.md)** |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.|SharePoint Online +**[Get‑PnPSiteDesignTask](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignTask.md)** |Used to retrieve a scheduled site design script. It takes the ID of the scheduled site design and the URL for the site where the site design is scheduled to be applied. |SharePoint Online +**[Remove‑PnPSiteDesignTask](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesignTask.md)** |Removes a Site Design Task. If the execution of the associated site script has already started the execution will not be terminated.|SharePoint Online +**[Add‑PnPSiteScript](../../sharepoint-ps/sharepoint-pnp/Add-PnPSiteScript.md)** |Creates a new Site Script on the current tenant.|SharePoint Online +**[Get‑PnPSiteScript](../../sharepoint-ps/sharepoint-pnp/Get-PnPSiteScript.md)** |Retrieve Site Scripts that have been registered on the current tenant.|SharePoint Online +**[Remove‑PnPSiteScript](../../sharepoint-ps/sharepoint-pnp/Remove-PnPSiteScript.md)** |Removes a Site Script|SharePoint Online +**[Set‑PnPSiteScript](../../sharepoint-ps/sharepoint-pnp/Set-PnPSiteScript.md)** |Updates an existing Site Script on the current tenant.|SharePoint Online +**[Get‑PnPStorageEntity](../../sharepoint-ps/sharepoint-pnp/Get-PnPStorageEntity.md)** |Retrieve Storage Entities / Farm Properties from either the Tenant App Catalog or from the current site if it has a site scope app catalog.|SharePoint Online +**[Remove‑PnPStorageEntity](../../sharepoint-ps/sharepoint-pnp/Remove-PnPStorageEntity.md)** |Remove Storage Entities / Farm Properties from either the tenant scoped app catalog or the current site collection if the site has a site collection scoped app catalog|SharePoint Online +**[Set‑PnPStorageEntity](../../sharepoint-ps/sharepoint-pnp/Set-PnPStorageEntity.md)** |Set Storage Entities / Farm Properties in either the tenant scoped app catalog or the site collection app catalog.|SharePoint Online +**[Get‑PnPTenant](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenant.md)** |Returns organization-level site collection properties|SharePoint Online +**[Set‑PnPTenant](../../sharepoint-ps/sharepoint-pnp/Set-PnPTenant.md)** |Sets organization-level site collection properties|SharePoint Online +**[Get‑PnPTenantAppCatalogUrl](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantAppCatalogUrl.md)** |Retrieves the url of the tenant scoped app catalog.|SharePoint Online +**[Get‑PnPTenantCdnEnabled](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnEnabled.md)** |Retrieves if the Office 365 Content Delivery Network has been enabled.|SharePoint Online +**[Set‑PnPTenantCdnEnabled](../../sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnEnabled.md)** |Enables or disabled the public or private Office 365 Content Delivery Network (CDN).|SharePoint Online +**[Add‑PnPTenantCdnOrigin](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantCdnOrigin.md)** |Adds a new origin to the public or private content delivery network (CDN).|SharePoint Online +**[Get‑PnPTenantCdnOrigin](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnOrigin.md)** |Returns the current registered origins from the public or private content delivery network (CDN).|SharePoint Online +**[Remove‑PnPTenantCdnOrigin](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTenantCdnOrigin.md)** |Removes an origin from the Public or Private content delivery network (CDN).|SharePoint Online +**[Get‑PnPTenantCdnPolicies](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnPolicies.md)** |Returns the CDN Policies for the specified CDN (Public | Private).|SharePoint Online +**[Set‑PnPTenantCdnPolicy](../../sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnPolicy.md)** |Sets the CDN Policies for the specified CDN (Public | Private).|SharePoint Online +**[Get‑PnPTenantId](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantId.md)** |Returns the Tenant ID|SharePoint Online +**[Clear‑PnPTenantRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Clear-PnPTenantRecycleBinItem.md)** |Permanently deletes a site collection from the tenant scoped recycle bin|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Restore‑PnPTenantRecycleBinItem](../../sharepoint-ps/sharepoint-pnp/Restore-PnPTenantRecycleBinItem.md)** |Restores a site collection from the tenant scoped recycle bin|SharePoint Online +**[Disable‑PnPTenantServicePrincipal](../../sharepoint-ps/sharepoint-pnp/Disable-PnPTenantServicePrincipal.md)** |Enables the current tenant's "SharePoint Online Client" service principal.|SharePoint Online +**[Enable‑PnPTenantServicePrincipal](../../sharepoint-ps/sharepoint-pnp/Enable-PnPTenantServicePrincipal.md)** |Enables the current tenant's "SharePoint Online Client" service principal.|SharePoint Online +**[Get‑PnPTenantServicePrincipal](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipal.md)** |Returns the current tenant's "SharePoint Online Client" service principal.|SharePoint Online +**[Revoke‑PnPTenantServicePrincipalPermission](../../sharepoint-ps/sharepoint-pnp/Revoke-PnPTenantServicePrincipalPermission.md)** |Revokes a permission that was previously granted to the "SharePoint Online Client" service principal.|SharePoint Online +**[Get‑PnPTenantServicePrincipalPermissionGrants](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionGrants.md)** |Gets the collection of permission grants for the "SharePoint Online Client" service principal|SharePoint Online +**[Approve‑PnPTenantServicePrincipalPermissionRequest](../../sharepoint-ps/sharepoint-pnp/Approve-PnPTenantServicePrincipalPermissionRequest.md)** |Approves a permission request for the current tenant's "SharePoint Online Client" service principal|SharePoint Online +**[Deny‑PnPTenantServicePrincipalPermissionRequest](../../sharepoint-ps/sharepoint-pnp/Deny-PnPTenantServicePrincipalPermissionRequest.md)** |Denies a permission request for the current tenant's "SharePoint Online Client" service principal|SharePoint Online +**[Get‑PnPTenantServicePrincipalPermissionRequests](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionRequests.md)** |Gets the collection of permission requests for the "SharePoint Online Client" service principal|SharePoint Online +**[Get‑PnPTenantSite](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantSite.md)** |Retrieve site information.|SharePoint Online +**[New‑PnPTenantSite](../../sharepoint-ps/sharepoint-pnp/New-PnPTenantSite.md)** |Creates a new (classic) site collection for the current tenant|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPTenantSite](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTenantSite.md)** |Removes a site collection|SharePoint Online +**[Set‑PnPTenantSite](../../sharepoint-ps/sharepoint-pnp/Set-PnPTenantSite.md)** |Set site information.|SharePoint Online +**[Add‑PnPTenantTheme](../../sharepoint-ps/sharepoint-pnp/Add-PnPTenantTheme.md)** |Adds or updates a theme to the tenant.|SharePoint Online +**[Get‑PnPTenantTheme](../../sharepoint-ps/sharepoint-pnp/Get-PnPTenantTheme.md)** |Returns all or a specific theme|SharePoint Online +**[Remove‑PnPTenantTheme](../../sharepoint-ps/sharepoint-pnp/Remove-PnPTenantTheme.md)** |Removes a theme|SharePoint Online +**[Get‑PnPTimeZoneId](../../sharepoint-ps/sharepoint-pnp/Get-PnPTimeZoneId.md)** |Returns a time zone ID|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPWebTemplates](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebTemplates.md)** |Returns the available web templates.|SharePoint Online + + +### User and group management Cmdlet|Description|Platform :-----|:----------|:------- -**[Add-PnPAlert](../../sharepoint-ps/sharepoint-pnp/Add-PnPAlert.md)** |Adds an alert for a user to a list|SharePoint Online, SharePoint 2019 -**[Get-PnPAlert](../../sharepoint-ps/sharepoint-pnp/Get-PnPAlert.md)** |Returns registered alerts for a user.|SharePoint Online, SharePoint 2019 -**[Remove-PnPAlert](../../sharepoint-ps/sharepoint-pnp/Remove-PnPAlert.md)** |Removes an alert for a user|SharePoint Online, SharePoint 2019 -**[Get-PnPGroup](../../sharepoint-ps/sharepoint-pnp/Get-PnPGroup.md)** |Returns a specific SharePoint group or all SharePoint groups in site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[New-PnPGroup](../../sharepoint-ps/sharepoint-pnp/New-PnPGroup.md)** |Adds group to the Site Groups List and returns a group object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPGroup](../../sharepoint-ps/sharepoint-pnp/Remove-PnPGroup.md)** |Removes a group from a web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPGroup](../../sharepoint-ps/sharepoint-pnp/Set-PnPGroup.md)** |Updates a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPGroupMembers](../../sharepoint-ps/sharepoint-pnp/Get-PnPGroupMembers.md)** |Retrieves all members of a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPGroupPermissions](../../sharepoint-ps/sharepoint-pnp/Get-PnPGroupPermissions.md)** |Returns the permissions for a specific SharePoint group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPGroupPermissions](../../sharepoint-ps/sharepoint-pnp/Set-PnPGroupPermissions.md)** |Adds and/or removes permissions of a specific SharePoint group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPUser](../../sharepoint-ps/sharepoint-pnp/Get-PnPUser.md)** |Returns site users of current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[New-PnPUser](../../sharepoint-ps/sharepoint-pnp/New-PnPUser.md)** |Adds a user to the built-in Site User Info List and returns a user object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPUser](../../sharepoint-ps/sharepoint-pnp/Remove-PnPUser.md)** |Removes a specific user from the site collection User Information List|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPUserFromGroup](../../sharepoint-ps/sharepoint-pnp/Remove-PnPUserFromGroup.md)** |Removes a user from a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPUserToGroup](../../sharepoint-ps/sharepoint-pnp/Add-PnPUserToGroup.md)** |Adds a user to a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online - -### User Profiles - +**[Add‑PnPAlert](../../sharepoint-ps/sharepoint-pnp/Add-PnPAlert.md)** |Adds an alert for a user to a list|SharePoint Online, SharePoint 2019 +**[Get‑PnPAlert](../../sharepoint-ps/sharepoint-pnp/Get-PnPAlert.md)** |Returns registered alerts for a user.|SharePoint Online, SharePoint 2019 +**[Remove‑PnPAlert](../../sharepoint-ps/sharepoint-pnp/Remove-PnPAlert.md)** |Removes an alert for a user|SharePoint Online, SharePoint 2019 +**[Get‑PnPGroup](../../sharepoint-ps/sharepoint-pnp/Get-PnPGroup.md)** |Returns a specific SharePoint group or all SharePoint groups in site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPGroup](../../sharepoint-ps/sharepoint-pnp/New-PnPGroup.md)** |Adds group to the Site Groups List and returns a group object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPGroup](../../sharepoint-ps/sharepoint-pnp/Remove-PnPGroup.md)** |Removes a group from a web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPGroup](../../sharepoint-ps/sharepoint-pnp/Set-PnPGroup.md)** |Updates a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPGroupMembers](../../sharepoint-ps/sharepoint-pnp/Get-PnPGroupMembers.md)** |Retrieves all members of a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPGroupPermissions](../../sharepoint-ps/sharepoint-pnp/Get-PnPGroupPermissions.md)** |Returns the permissions for a specific SharePoint group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPGroupPermissions](../../sharepoint-ps/sharepoint-pnp/Set-PnPGroupPermissions.md)** |Adds and/or removes permissions of a specific SharePoint group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPUser](../../sharepoint-ps/sharepoint-pnp/Get-PnPUser.md)** |Returns site users of current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPUser](../../sharepoint-ps/sharepoint-pnp/New-PnPUser.md)** |Adds a user to the built-in Site User Info List and returns a user object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPUser](../../sharepoint-ps/sharepoint-pnp/Remove-PnPUser.md)** |Removes a specific user from the site collection User Information List|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPUserFromGroup](../../sharepoint-ps/sharepoint-pnp/Remove-PnPUserFromGroup.md)** |Removes a user from a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPUserToGroup](../../sharepoint-ps/sharepoint-pnp/Add-PnPUserToGroup.md)** |Adds a user to a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### User Profiles Cmdlet|Description|Platform :-----|:----------|:------- -**[New-PnPPersonalSite](../../sharepoint-ps/sharepoint-pnp/New-PnPPersonalSite.md)** |Office365 only: Creates a personal / OneDrive For Business site|SharePoint Online -**[New-PnPUPABulkImportJob](../../sharepoint-ps/sharepoint-pnp/New-PnPUPABulkImportJob.md)** |Submit up a new user profile bulk import job.|SharePoint Online -**[Get-PnPUPABulkImportStatus](../../sharepoint-ps/sharepoint-pnp/Get-PnPUPABulkImportStatus.md)** |Get user profile bulk import status.|SharePoint Online -**[Get-PnPUserProfileProperty](../../sharepoint-ps/sharepoint-pnp/Get-PnPUserProfileProperty.md)** |You must connect to the tenant admin website (https://:-admin.sharepoint.com) with Connect-PnPOnline in order to use this cmdlet. |SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPUserProfileProperty](../../sharepoint-ps/sharepoint-pnp/Set-PnPUserProfileProperty.md)** |Office365 only: Uses the tenant API to retrieve site information. You must connect to the tenant admin website (https://:-admin.sharepoint.com) with Connect-PnPOnline in order to use this command. |SharePoint Online +**[New‑PnPPersonalSite](../../sharepoint-ps/sharepoint-pnp/New-PnPPersonalSite.md)** |Office365 only: Creates a personal / OneDrive For Business site|SharePoint Online +**[New‑PnPUPABulkImportJob](../../sharepoint-ps/sharepoint-pnp/New-PnPUPABulkImportJob.md)** |Submit up a new user profile bulk import job.|SharePoint Online +**[Get‑PnPUPABulkImportStatus](../../sharepoint-ps/sharepoint-pnp/Get-PnPUPABulkImportStatus.md)** |Get user profile bulk import status.|SharePoint Online +**[Get‑PnPUserProfileProperty](../../sharepoint-ps/sharepoint-pnp/Get-PnPUserProfileProperty.md)** |You must connect to the tenant admin website (https://:-admin.sharepoint.com) with Connect-PnPOnline in order to use this cmdlet. |SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPUserProfileProperty](../../sharepoint-ps/sharepoint-pnp/Set-PnPUserProfileProperty.md)** |Office365 only: Uses the tenant API to retrieve site information. You must connect to the tenant admin website (https://:-admin.sharepoint.com) with Connect-PnPOnline in order to use this command. |SharePoint Online -### Utilities +### Utilities Cmdlet|Description|Platform :-----|:----------|:------- -**[Send-PnPMail](../../sharepoint-ps/sharepoint-pnp/Send-PnPMail.md)** |Sends an email using the Office 365 SMTP Service or SharePoint, depending on the parameters specified. See detailed help for more information.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Send‑PnPMail](../../sharepoint-ps/sharepoint-pnp/Send-PnPMail.md)** |Sends an email using the Office 365 SMTP Service or SharePoint, depending on the parameters specified. See detailed help for more information.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -### Web Parts +### Web Parts Cmdlet|Description|Platform :-----|:----------|:------- -**[Get-PnPClientSideComponent](../../sharepoint-ps/sharepoint-pnp/Get-PnPClientSideComponent.md)** |Retrieve one or more Client-Side components from a page|SharePoint Online, SharePoint 2019 -**[Remove-PnPClientSideComponent](../../sharepoint-ps/sharepoint-pnp/Remove-PnPClientSideComponent.md)** |Removes a Client-Side component from a page|SharePoint Online, SharePoint 2019 -**[Set-PnPClientSideText](../../sharepoint-ps/sharepoint-pnp/Set-PnPClientSideText.md)** |Set Client-Side Text Component properties|SharePoint Online, SharePoint 2019 -**[Set-PnPClientSideWebPart](../../sharepoint-ps/sharepoint-pnp/Set-PnPClientSideWebPart.md)** |Set Client-Side Web Part properties|SharePoint Online, SharePoint 2019 -**[Get-PnPWebPart](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebPart.md)** |Returns a web part definition object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPWebPart](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWebPart.md)** |Removes a web part from a page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPWebPartProperty](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebPartProperty.md)** |Returns a web part property|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPWebPartProperty](../../sharepoint-ps/sharepoint-pnp/Set-PnPWebPartProperty.md)** |Sets a web part property|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPWebPartToWebPartPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWebPartPage.md)** |Adds a web part to a web part page in a specified zone|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPWebPartToWikiPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWikiPage.md)** |Adds a web part to a wiki page in a specified table row and column|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPWebPartXml](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebPartXml.md)** |Returns the web part XML of a web part registered on a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online - -### Webs - +**[Get‑PnPClientSideComponent](../../sharepoint-ps/sharepoint-pnp/Get-PnPClientSideComponent.md)** |Retrieve one or more Client-Side components from a page|SharePoint Online, SharePoint 2019 +**[Remove‑PnPClientSideComponent](../../sharepoint-ps/sharepoint-pnp/Remove-PnPClientSideComponent.md)** |Removes a Client-Side component from a page|SharePoint Online, SharePoint 2019 +**[Set‑PnPClientSideText](../../sharepoint-ps/sharepoint-pnp/Set-PnPClientSideText.md)** |Set Client-Side Text Component properties|SharePoint Online, SharePoint 2019 +**[Set‑PnPClientSideWebPart](../../sharepoint-ps/sharepoint-pnp/Set-PnPClientSideWebPart.md)** |Set Client-Side Web Part properties|SharePoint Online, SharePoint 2019 +**[Get‑PnPWebPart](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebPart.md)** |Returns a web part definition object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPWebPart](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWebPart.md)** |Removes a web part from a page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPWebPartProperty](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebPartProperty.md)** |Returns a web part property|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPWebPartProperty](../../sharepoint-ps/sharepoint-pnp/Set-PnPWebPartProperty.md)** |Sets a web part property|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPWebPartToWebPartPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWebPartPage.md)** |Adds a web part to a web part page in a specified zone|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPWebPartToWikiPage](../../sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWikiPage.md)** |Adds a web part to a wiki page in a specified table row and column|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPWebPartXml](../../sharepoint-ps/sharepoint-pnp/Get-PnPWebPartXml.md)** |Returns the web part XML of a web part registered on a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Webs Cmdlet|Description|Platform :-----|:----------|:------- -**[Set-PnPIndexedProperties](../../sharepoint-ps/sharepoint-pnp/Set-PnPIndexedProperties.md)** |Marks values of the propertybag to be indexed by search. Notice that this will overwrite the existing flags, i.e. only the properties you define with the cmdlet will be indexed.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPIndexedProperty](../../sharepoint-ps/sharepoint-pnp/Add-PnPIndexedProperty.md)** |Marks the value of the propertybag key specified to be indexed by search.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPIndexedProperty](../../sharepoint-ps/sharepoint-pnp/Remove-PnPIndexedProperty.md)** |Removes a key from propertybag to be indexed by search. The key and it's value remain in the propertybag, however it will not be indexed anymore.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPIndexedPropertyKeys](../../sharepoint-ps/sharepoint-pnp/Get-PnPIndexedPropertyKeys.md)** |Returns the keys of the property bag values that have been marked for indexing by search|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPPropertyBag](../../sharepoint-ps/sharepoint-pnp/Get-PnPPropertyBag.md)** |Returns the property bag values.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPPropertyBagValue](../../sharepoint-ps/sharepoint-pnp/Remove-PnPPropertyBagValue.md)** |Removes a value from the property bag|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPPropertyBagValue](../../sharepoint-ps/sharepoint-pnp/Set-PnPPropertyBagValue.md)** |Sets a property bag value|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Request-PnPReIndexWeb](../../sharepoint-ps/sharepoint-pnp/Request-PnPReIndexWeb.md)** |Marks the web for full indexing during the next incremental crawl|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPRequestAccessEmails](../../sharepoint-ps/sharepoint-pnp/Get-PnPRequestAccessEmails.md)** |Returns the request access e-mail addresses|SharePoint Online -**[Set-PnPRequestAccessEmails](../../sharepoint-ps/sharepoint-pnp/Set-PnPRequestAccessEmails.md)** |Sets Request Access Emails on a web|SharePoint Online -**[Get-PnPSubWebs](../../sharepoint-ps/sharepoint-pnp/Get-PnPSubWebs.md)** |Returns the subwebs of the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPWeb](../../sharepoint-ps/sharepoint-pnp/Get-PnPWeb.md)** |Returns the current web object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[New-PnPWeb](../../sharepoint-ps/sharepoint-pnp/New-PnPWeb.md)** |Creates a new subweb under the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPWeb](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWeb.md)** |Removes a subweb in the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPWeb](../../sharepoint-ps/sharepoint-pnp/Set-PnPWeb.md)** |Sets properties on a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Invoke-PnPWebAction](../../sharepoint-ps/sharepoint-pnp/Invoke-PnPWebAction.md)** |Executes operations on web, lists and list items.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Set-PnPWebPermission](../../sharepoint-ps/sharepoint-pnp/Set-PnPWebPermission.md)** |Set permissions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online - -### Workflows - +**[Set‑PnPIndexedProperties](../../sharepoint-ps/sharepoint-pnp/Set-PnPIndexedProperties.md)** |Marks values of the propertybag to be indexed by search. Notice that this will overwrite the existing flags, i.e. only the properties you define with the cmdlet will be indexed.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPIndexedProperty](../../sharepoint-ps/sharepoint-pnp/Add-PnPIndexedProperty.md)** |Marks the value of the propertybag key specified to be indexed by search.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPIndexedProperty](../../sharepoint-ps/sharepoint-pnp/Remove-PnPIndexedProperty.md)** |Removes a key from propertybag to be indexed by search. The key and it's value remain in the propertybag, however it will not be indexed anymore.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPIndexedPropertyKeys](../../sharepoint-ps/sharepoint-pnp/Get-PnPIndexedPropertyKeys.md)** |Returns the keys of the property bag values that have been marked for indexing by search|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPPropertyBag](../../sharepoint-ps/sharepoint-pnp/Get-PnPPropertyBag.md)** |Returns the property bag values.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPPropertyBagValue](../../sharepoint-ps/sharepoint-pnp/Remove-PnPPropertyBagValue.md)** |Removes a value from the property bag|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPPropertyBagValue](../../sharepoint-ps/sharepoint-pnp/Set-PnPPropertyBagValue.md)** |Sets a property bag value|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Request‑PnPReIndexWeb](../../sharepoint-ps/sharepoint-pnp/Request-PnPReIndexWeb.md)** |Marks the web for full indexing during the next incremental crawl|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPRequestAccessEmails](../../sharepoint-ps/sharepoint-pnp/Get-PnPRequestAccessEmails.md)** |Returns the request access e-mail addresses|SharePoint Online +**[Set‑PnPRequestAccessEmails](../../sharepoint-ps/sharepoint-pnp/Set-PnPRequestAccessEmails.md)** |Sets Request Access Emails on a web|SharePoint Online +**[Get‑PnPSubWebs](../../sharepoint-ps/sharepoint-pnp/Get-PnPSubWebs.md)** |Returns the subwebs of the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPWeb](../../sharepoint-ps/sharepoint-pnp/Get-PnPWeb.md)** |Returns the current web object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[New‑PnPWeb](../../sharepoint-ps/sharepoint-pnp/New-PnPWeb.md)** |Creates a new subweb under the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPWeb](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWeb.md)** |Removes a subweb in the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPWeb](../../sharepoint-ps/sharepoint-pnp/Set-PnPWeb.md)** |Sets properties on a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Invoke‑PnPWebAction](../../sharepoint-ps/sharepoint-pnp/Invoke-PnPWebAction.md)** |Executes operations on web, lists and list items.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Set‑PnPWebPermission](../../sharepoint-ps/sharepoint-pnp/Set-PnPWebPermission.md)** |Set permissions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Workflows Cmdlet|Description|Platform :-----|:----------|:------- -**[Add-PnPWorkflowDefinition](../../sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowDefinition.md)** |Adds a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPWorkflowDefinition](../../sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowDefinition.md)** |Returns a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPWorkflowDefinition](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowDefinition.md)** |Removes a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPWorkflowInstance](../../sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowInstance.md)** |Get workflow instances|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Resume-PnPWorkflowInstance](../../sharepoint-ps/sharepoint-pnp/Resume-PnPWorkflowInstance.md)** |Resume a workflow|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Start-PnPWorkflowInstance](../../sharepoint-ps/sharepoint-pnp/Start-PnPWorkflowInstance.md)** |Starts a workflow instance on a list item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Stop-PnPWorkflowInstance](../../sharepoint-ps/sharepoint-pnp/Stop-PnPWorkflowInstance.md)** |Stops a workflow instance|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Add-PnPWorkflowSubscription](../../sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowSubscription.md)** |Adds a workflow subscription to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Get-PnPWorkflowSubscription](../../sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowSubscription.md)** |Return a workflow subscription|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online -**[Remove-PnPWorkflowSubscription](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowSubscription.md)** |Remove workflow subscription|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPWorkflowDefinition](../../sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowDefinition.md)** |Adds a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPWorkflowDefinition](../../sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowDefinition.md)** |Returns a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPWorkflowDefinition](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowDefinition.md)** |Removes a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPWorkflowInstance](../../sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowInstance.md)** |Get workflow instances|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Resume‑PnPWorkflowInstance](../../sharepoint-ps/sharepoint-pnp/Resume-PnPWorkflowInstance.md)** |Resume a workflow|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Start‑PnPWorkflowInstance](../../sharepoint-ps/sharepoint-pnp/Start-PnPWorkflowInstance.md)** |Starts a workflow instance on a list item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Stop‑PnPWorkflowInstance](../../sharepoint-ps/sharepoint-pnp/Stop-PnPWorkflowInstance.md)** |Stops a workflow instance|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Add‑PnPWorkflowSubscription](../../sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowSubscription.md)** |Adds a workflow subscription to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Get‑PnPWorkflowSubscription](../../sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowSubscription.md)** |Return a workflow subscription|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +**[Remove‑PnPWorkflowSubscription](../../sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowSubscription.md)** |Remove workflow subscription|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + ## Additional resources -* [SharePoint PnP PowerShell on GitHub](https://github.com/SharePoint/PnP-PowerShell) +- [SharePoint PnP PowerShell on GitHub](https://github.com/SharePoint/PnP-PowerShell) diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAlert.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAlert.md index 8a7e93a182..c9f5f7b0c4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAlert.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAlert.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds an alert for a user to a list -## SYNTAX +## SYNTAX ```powershell Add-PnPAlert -List @@ -196,4 +196,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApp.md index c5ccb94761..6677eb85f8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApp.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApp.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Add/uploads an available app to the app catalog -## SYNTAX +## SYNTAX ### Add only ```powershell @@ -161,4 +161,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApplicationCustomizer.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApplicationCustomizer.md new file mode 100644 index 0000000000..dc42ddf328 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApplicationCustomizer.md @@ -0,0 +1,169 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/add-pnpapplicationcustomizer +applicable: SharePoint Online, SharePoint 2019 +schema: 2.0.0 +--- + +# Add-PnPApplicationCustomizer + +## SYNOPSIS +Adds a SharePoint Framework client side extension application customizer + +## SYNTAX + +```powershell +Add-PnPApplicationCustomizer -ClientSideComponentId + [-Title ] + [-Description ] + [-Sequence ] + [-Scope ] + [-ClientSideComponentProperties ] + [-ClientSideHostProperties ] + [-Web ] + [-Connection ] +``` + +## DESCRIPTION +Adds a SharePoint Framework client side extension application customizer by registering a user custom action to a web or sitecollection + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Add-PnPApplicationCustomizer -Title "CollabFooter" -ClientSideComponentId c0ab3b94-8609-40cf-861e-2a1759170b43 -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"} +``` + +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. + +## PARAMETERS + +### -ClientSideComponentId +The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: GuidPipeBind +Parameter Sets: (All) + +Required: True +Position: Named +Accept pipeline input: False +``` + +### -ClientSideComponentProperties +The Client Side Component Properties of the application customizer. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}" + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -ClientSideHostProperties +The Client Side Host Properties of the application customizer. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}" + +Only applicable to: SharePoint Online + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Description +The description of the application customizer + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Scope +The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: CustomActionScope +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Sequence +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. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: Int +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Title +The title of the application customizer + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Web +This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: WebPipeBind +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePage.md index ce70e7bbdf..c2347f0a56 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a Client-Side Page -## SYNTAX +## SYNTAX ```powershell Add-PnPClientSidePage -Name @@ -46,6 +46,13 @@ Add-PnPClientSidePage -Name "NewPageTemplate" -PromoteAs Template Creates a new Client-Side page named 'NewPage' and saves as a template to the site. +### ------------------EXAMPLE 4------------------ +```powershell +Add-PnPClientSidePage -Name "Folder/NewPage" +``` + +Creates a new Client-Side page named 'NewPage' under 'Folder' folder and saves as a template to the site. + ## PARAMETERS ### -CommentsEnabled @@ -162,4 +169,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePageSection.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePageSection.md index 2128aad399..6299d280e0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePageSection.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSidePageSection.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a new section to a Client-Side page -## SYNTAX +## SYNTAX ```powershell Add-PnPClientSidePageSection -Page @@ -141,4 +141,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideText.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideText.md index 89e4b47004..e0b96dd8e6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideText.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideText.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a text element to a client-side page. -## SYNTAX +## SYNTAX ### Default ```powershell @@ -146,4 +146,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideWebPart.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideWebPart.md index 4f8757c5a4..b6f1596a38 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideWebPart.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPClientSideWebPart.md @@ -1,7 +1,7 @@ --- external help file: online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/add-pnpclientsidewebpart -applicable: SharePoint Online +applicable: SharePoint Online, SharePoint 2019 schema: 2.0.0 --- @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a Client-Side Web Part to a client-side page -## SYNTAX +## SYNTAX ### Default with built-in web part ```powershell @@ -87,6 +87,8 @@ Adds a Client-Side component 'HelloWorld' to the page called 'MyPage' in section ### -Column Sets the column where to insert the web part control. +Only applicable to: SharePoint Online, SharePoint Server 2019 + ```yaml Type: Int Parameter Sets: Positioned with built-in web part, Positioned with 3rd party web part @@ -99,6 +101,8 @@ Accept pipeline input: False ### -Component Specifies the component instance or Id to add. +Only applicable to: SharePoint Online, SharePoint Server 2019 + ```yaml Type: ClientSideComponentPipeBind Parameter Sets: Default with 3rd party web part, Positioned with 3rd party web part @@ -111,6 +115,8 @@ Accept pipeline input: False ### -DefaultWebPartType Defines a default web part type to insert. +Only applicable to: SharePoint Online, SharePoint Server 2019 + ```yaml Type: DefaultClientSideWebParts Parameter Sets: Default with built-in web part, Positioned with built-in web part @@ -123,6 +129,8 @@ Accept pipeline input: False ### -Order Sets the order of the web part control. (Default = 1) +Only applicable to: SharePoint Online, SharePoint Server 2019 + ```yaml Type: Int Parameter Sets: Default with built-in web part, Default with 3rd party web part, Positioned with built-in web part, Positioned with 3rd party web part @@ -135,6 +143,8 @@ Accept pipeline input: False ### -Page The name of the page. +Only applicable to: SharePoint Online, SharePoint Server 2019 + ```yaml Type: ClientSidePagePipeBind Parameter Sets: Default with built-in web part, Default with 3rd party web part, Positioned with built-in web part, Positioned with 3rd party web part @@ -147,6 +157,8 @@ Accept pipeline input: True ### -Section Sets the section where to insert the web part control. +Only applicable to: SharePoint Online, SharePoint Server 2019 + ```yaml Type: Int Parameter Sets: Positioned with built-in web part, Positioned with 3rd party web part @@ -159,6 +171,8 @@ Accept pipeline input: False ### -WebPartProperties The properties of the web part +Only applicable to: SharePoint Online, SharePoint Server 2019 + ```yaml Type: PropertyBagPipeBind Parameter Sets: Default with built-in web part, Default with 3rd party web part, Positioned with built-in web part, Positioned with 3rd party web part @@ -171,6 +185,8 @@ Accept pipeline input: False ### -Connection Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. +Only applicable to: SharePoint Online, SharePoint Server 2019 + ```yaml Type: SPOnlineConnection Parameter Sets: (All) @@ -183,6 +199,8 @@ Accept pipeline input: False ### -Web This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. +Only applicable to: SharePoint Online, SharePoint Server 2019 + ```yaml Type: WebPipeBind Parameter Sets: (All) @@ -194,4 +212,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md index 733dd5950b..036abc0843 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a new content type -## SYNTAX +## SYNTAX ```powershell Add-PnPContentType -Name @@ -123,4 +123,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md index 2b39f1cadd..1219038977 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a content type to a document set -## SYNTAX +## SYNTAX ```powershell Add-PnPContentTypeToDocumentSet -ContentType @@ -96,4 +96,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md index 45fce53f71..05900c02e9 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a new content type to a list -## SYNTAX +## SYNTAX ```powershell Add-PnPContentTypeToList -List @@ -93,4 +93,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md index a63c1c70d8..96eb96f6ff 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a custom action -## SYNTAX +## SYNTAX ### Client Side Component Id ```powershell @@ -18,10 +18,12 @@ Add-PnPCustomAction -Name -Title -Location -ClientSideComponentId + [-Sequence ] [-RegistrationId ] [-RegistrationType ] [-Scope ] [-ClientSideComponentProperties ] + [-ClientSideHostProperties ] [-Web ] [-Connection ] ``` @@ -64,7 +66,7 @@ Adds a new custom action to the custom list template, and sets the Title, Name a Add-PnPCustomAction -Title "CollabFooter" -Name "CollabFooter" -Location "ClientSideExtension.ApplicationCustomizer" -ClientSideComponentId c0ab3b94-8609-40cf-861e-2a1759170b43 -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"} ``` -Adds a new application customizer to the site. This requires that an SPFX solution has been deployed containing the application customizer specified. +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. ## PARAMETERS @@ -96,6 +98,20 @@ Position: Named Accept pipeline input: False ``` +### -ClientSideHostProperties +The Client Side Host Properties of the custom action. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}" + +Only applicable to: SharePoint Online + +```yaml +Type: String +Parameter Sets: Client Side Component Id + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -CommandUIExtension XML fragment that determines user interface properties of the custom action @@ -221,7 +237,7 @@ Sequence of this CustomAction being injected. Use when you have a specific seque ```yaml Type: Int -Parameter Sets: Default +Parameter Sets: Default, Client Side Component Id Required: False Position: Named @@ -278,4 +294,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[UserCustomAction](https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.usercustomaction.aspx)[BasePermissions](https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.basepermissions.aspx) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[UserCustomAction](https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee539583(v=office.15))[BasePermissions](https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee543321(v=office.15)) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDataRowsToProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDataRowsToProvisioningTemplate.md index 6b5f553a25..2bfe0e1614 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDataRowsToProvisioningTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDataRowsToProvisioningTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds datarows to a list inside a PnP Provisioning Template -## SYNTAX +## SYNTAX ```powershell Add-PnPDataRowsToProvisioningTemplate -Path @@ -31,14 +31,14 @@ Add-PnPDataRowsToProvisioningTemplate -Path Add-PnPDataRowsToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Query '' -Fields 'Title','Choice' ``` -Adds datarows to a list in an in-memory PnP Provisioning Template +Adds datarows from the provided list to the PnP Provisioning Template at the provided location ### ------------------EXAMPLE 2------------------ ```powershell Add-PnPDataRowsToProvisioningTemplate -Path template.pnp -List 'PnPTestList' -Query '' -Fields 'Title','Choice' -IncludeSecurity ``` -Adds datarows to a list in an in-memory PnP Provisioning Template +Adds datarows from the provided list to the PnP Provisioning Template at the provided location ## PARAMETERS @@ -152,4 +152,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDocumentSet.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDocumentSet.md index 8f6af52c4e..449d0c58f7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDocumentSet.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPDocumentSet.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a new document set in a library. -## SYNTAX +## SYNTAX ```powershell Add-PnPDocumentSet -List @@ -97,4 +97,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPEventReceiver.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPEventReceiver.md index d2f02faf4f..357a8d260e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPEventReceiver.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPEventReceiver.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a new remote event receiver -## SYNTAX +## SYNTAX ```powershell Add-PnPEventReceiver -Name @@ -158,4 +158,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPField.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPField.md index b9c9f2dd8f..3fc4169a55 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPField.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPField.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Add a field -## SYNTAX +## SYNTAX ### Add field by XML to list ```powershell @@ -279,4 +279,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldFromXml.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldFromXml.md index 8a422b184c..93f926be5e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldFromXml.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldFromXml.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a field to a list or as a site column based upon a CAML/XML field definition -## SYNTAX +## SYNTAX ```powershell Add-PnPFieldFromXml -FieldXml @@ -93,4 +93,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Field CAML](https://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Field CAML](http://msdn.microsoft.com/en-us/library/office/ms437580(v=office.15).aspx) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldToContentType.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldToContentType.md index af9dc5a80a..846fb4f9e1 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldToContentType.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFieldToContentType.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds an existing site column to a content type -## SYNTAX +## SYNTAX ```powershell Add-PnPFieldToContentType -Field @@ -106,4 +106,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFile.md index dcf279cd65..f31f16f425 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFile.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFile.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Uploads a file to Web -## SYNTAX +## SYNTAX ### Upload file ```powershell @@ -80,14 +80,14 @@ This will add a file sample.doc with the contents of the stream into the Shared ### ------------------EXAMPLE 5------------------ ```powershell -Add-PnPFile -FileName sample.doc -Folder "Shared Documents" -ContentType "Document" -Values @{Modified="1/1/2016"} +Add-PnPFile -Path sample.doc -Folder "Shared Documents" -ContentType "Document" -Values @{Modified="1/1/2016"} ``` This will add a file sample.doc to the Shared Documents folder, with a ContentType of 'Documents'. After adding it will set the Modified date to 1/1/2016. ### ------------------EXAMPLE 6------------------ ```powershell -Add-PnPFile -FileName sample.docx -Folder "Documents" -Values @{Modified="1/1/2016"; Created="1/1/2017"; Editor=23} +Add-PnPFile -Path sample.docx -Folder "Documents" -Values @{Modified="1/1/2016"; Created="1/1/2017"; Editor=23} ``` This will add a file sample.docx to the Documents folder and will set the Modified date to 1/1/2016, Created date to 1/1/2017 and the Modified By field to the user with ID 23. To find out about the proper user ID to relate to a specific user, use Get-PnPUser. @@ -337,4 +337,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFileToProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFileToProvisioningTemplate.md index e2b7f61874..92ee4a3605 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFileToProvisioningTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFileToProvisioningTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a file to a PnP Provisioning Template -## SYNTAX +## SYNTAX ### Remove File ```powershell @@ -198,4 +198,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFolder.md index b1fdeebff7..7e7af8be3a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFolder.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPFolder.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a folder within a parent folder -## SYNTAX +## SYNTAX ```powershell Add-PnPFolder -Name @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHtmlPublishingPageLayout.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHtmlPublishingPageLayout.md index 98500fbabe..340e162d79 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHtmlPublishingPageLayout.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHtmlPublishingPageLayout.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a HTML based publishing page layout -## SYNTAX +## SYNTAX ```powershell Add-PnPHtmlPublishingPageLayout -SourceFilePath @@ -119,4 +119,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHubSiteAssociation.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHubSiteAssociation.md index 936c80c793..5e39dca16c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHubSiteAssociation.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPHubSiteAssociation.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Connects a site to a hubsite. -## SYNTAX +## SYNTAX ```powershell Add-PnPHubSiteAssociation -Site @@ -70,4 +70,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPIndexedProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPIndexedProperty.md index f1660abdb0..d42fc0baa4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPIndexedProperty.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPIndexedProperty.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Marks the value of the propertybag key specified to be indexed by search. -## SYNTAX +## SYNTAX ```powershell Add-PnPIndexedProperty -Key @@ -71,4 +71,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptBlock.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptBlock.md index b399dd1492..e92deb3ef3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptBlock.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptBlock.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a link to a JavaScript snippet/block to a web or site collection -## SYNTAX +## SYNTAX ```powershell Add-PnPJavaScriptBlock -Name @@ -117,4 +117,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptLink.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptLink.md index 2f37fcf6fd..f0ae21e6e9 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptLink.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPJavaScriptLink.md @@ -8,9 +8,9 @@ schema: 2.0.0 # Add-PnPJavaScriptLink ## SYNOPSIS -Adds a link to a JavaScript file to a web or sitecollection +Adds a link to a JavaScript file to a web or sitecollection, valid only for SharePoint classic site experience. -## SYNTAX +## SYNTAX ```powershell Add-PnPJavaScriptLink -Name @@ -117,4 +117,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListFoldersToProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListFoldersToProvisioningTemplate.md index 225b7dba2a..e0c0bf53ab 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListFoldersToProvisioningTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListFoldersToProvisioningTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds folders to a list in a PnP Provisioning Template -## SYNTAX +## SYNTAX ```powershell Add-PnPListFoldersToProvisioningTemplate -Path @@ -133,4 +133,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListItem.md index b625acd4a8..be0bab7a7e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPListItem.md @@ -10,13 +10,14 @@ schema: 2.0.0 ## SYNOPSIS 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. -## SYNTAX +## SYNTAX ```powershell Add-PnPListItem -List [-ContentType ] [-Values ] [-Folder ] + [-Label ] [-Web ] [-Connection ] ``` @@ -51,6 +52,13 @@ Add-PnPListItem -List "Demo List" -Values @{"Title"="Sales Report"} -Folder "pro 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. +### ------------------EXAMPLE 5------------------ +```powershell +Add-PnPListItem -List "Demo List" -Values @{"Title"="Sales Report"} -Label "Public" +``` + +Adds a new list item to the "Demo List". Sets the retention label to "Public" if it exists on the site. + ## PARAMETERS ### -ContentType @@ -77,6 +85,20 @@ Position: Named Accept pipeline input: False ``` +### -Label +The name of the retention label. + +Only applicable to: SharePoint Online + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -List The ID, Title or Url of the list. @@ -169,4 +191,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPMasterPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPMasterPage.md index 34c60a9822..70d35938bb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPMasterPage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPMasterPage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a Masterpage -## SYNTAX +## SYNTAX ```powershell Add-PnPMasterPage -SourceFilePath @@ -136,4 +136,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPNavigationNode.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPNavigationNode.md index e7995b7d37..f905f8e2c6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPNavigationNode.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPNavigationNode.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds an item to a navigation element -## SYNTAX +## SYNTAX ```powershell Add-PnPNavigationNode -Location @@ -167,4 +167,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOffice365GroupToSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOffice365GroupToSite.md index b1f09316fe..d94e359ef7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOffice365GroupToSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOffice365GroupToSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Groupifies a classic team site by creating an Office 365 group for it and connecting the site with the newly created group -## SYNTAX +## SYNTAX ```powershell Add-PnPOffice365GroupToSite -Url @@ -161,4 +161,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOrgAssetsLibrary.md new file mode 100644 index 0000000000..91ee516339 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOrgAssetsLibrary.md @@ -0,0 +1,100 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/add-pnporgassetslibrary +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Add-PnPOrgAssetsLibrary + +## SYNOPSIS +Adds a given document library as a organizational asset source + +## SYNTAX + +```powershell +Add-PnPOrgAssetsLibrary -LibraryUrl + [-ThumbnailUrl ] + [-CdnType ] + [-Connection ] +``` + +## DESCRIPTION +Adds a given document library as an organizational asset source in your Sharepoint Online Tenant. All organizational asset sources you add must reside in the same site collection. Document libraries specified as organizational asset must be enabled as an Office 365 CDN source, either as private or public. It may take some time before this change will be reflected in the webinterface. + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Add-PnPOrgAssetsLibrary -LibraryUrl https://yourtenant.sharepoint.com/sites/branding/logos +``` + +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 + +### ------------------EXAMPLE 2------------------ +```powershell +Add-PnPOrgAssetsLibrary -LibraryUrl https://yourtenant.sharepoint.com/sites/branding/logos -ThumbnailUrl https://yourtenant.sharepoint.com/sites/branding/logos/thumbnail.jpg +``` + +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 + +### ------------------EXAMPLE 3------------------ +```powershell +Add-PnPOrgAssetsLibrary -LibraryUrl https://yourtenant.sharepoint.com/sites/branding/logos -CdnType Private +``` + +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 + +## PARAMETERS + +### -CdnType +Indicates what type of Office 365 CDN source the document library will be added to + +```yaml +Type: SPOTenantCdnType +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -LibraryUrl +The full url of the document library to be marked as one of organization's assets sources + +```yaml +Type: String +Parameter Sets: (All) + +Required: True +Position: Named +Accept pipeline input: False +``` + +### -ThumbnailUrl +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. + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOrgNewsSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOrgNewsSite.md new file mode 100644 index 0000000000..631c24244b --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPOrgNewsSite.md @@ -0,0 +1,57 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/add-pnporgnewssite +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Add-PnPOrgNewsSite + +## SYNOPSIS +Adds the site as an organization news source in your tenant + +## SYNTAX + +```powershell +Add-PnPOrgNewsSite -OrgNewsSiteUrl + [-Connection ] +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Add-PnPOrgNewsSite -OrgNewsSiteUrl https://yourtenant.sharepoint.com/sites/news +``` + +Adds the site as one of multiple possible tenant's organizational news sites + +## PARAMETERS + +### -OrgNewsSiteUrl +The url of the site to be marked as one of organization's news sites + +```yaml +Type: SitePipeBind +Parameter Sets: (All) + +Required: True +Position: Named +Accept pipeline input: False +``` + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningTemplate.md index 2059a0c64f..40af56b07c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPProvisioningTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a PnP Provisioning Template object to a tenant template -## SYNTAX +## SYNTAX ```powershell Add-PnPProvisioningTemplate -SiteTemplate @@ -34,7 +34,6 @@ The template to add to the tenant template ```yaml Type: ProvisioningTemplate Parameter Sets: (All) -Aliases: Template Required: True Position: Named @@ -47,7 +46,6 @@ The tenant template to add the template to ```yaml Type: ProvisioningHierarchy Parameter Sets: (All) -Aliases: Hierarchy Required: True Position: Named @@ -56,4 +54,4 @@ Accept pipeline input: True ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingImageRendition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingImageRendition.md index fbd5b768bf..60454ea304 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingImageRendition.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingImageRendition.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS 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. -## SYNTAX +## SYNTAX ```powershell Add-PnPPublishingImageRendition -Name @@ -93,4 +93,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPage.md index ac05afbe79..e0235a2ab6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a publishing page -## SYNTAX +## SYNTAX ### WithTitle ```powershell @@ -129,4 +129,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPageLayout.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPageLayout.md index 08d9d2f551..eb43d36740 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPageLayout.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPPublishingPageLayout.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a publishing page layout -## SYNTAX +## SYNTAX ```powershell Add-PnPPublishingPageLayout -SourceFilePath @@ -119,4 +119,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPRoleDefinition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPRoleDefinition.md index f29e13654f..bd5069dd9a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPRoleDefinition.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPRoleDefinition.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a Role Defintion (Permission Level) to the site collection in the current context -## SYNTAX +## SYNTAX ```powershell Add-PnPRoleDefinition -RoleName @@ -49,7 +49,7 @@ Creates additional permission level by cloning "Contribute" and removes flags De ### ------------------EXAMPLE 4------------------ ```powershell -PS> $roleDefinition = Get-PnPRoleDefinition -Identity "Contribute" +$roleDefinition = Get-PnPRoleDefinition -Identity "Contribute" Add-PnPRoleDefinition -RoleName "AddOnly" -Clone $roleDefinition -Exclude DeleteListItems, EditListItems ``` @@ -82,7 +82,7 @@ Accept pipeline input: False ``` ### -Exclude -Specifies permission flags(s) to disable. +Specifies permission flags(s) to disable. Please visit https://docs.microsoft.com/previous-versions/office/sharepoint-csom/ee536458(v%3Doffice.15) for the PermissionKind enum ```yaml Type: PermissionKind[] @@ -94,7 +94,7 @@ Accept pipeline input: False ``` ### -Include -Specifies permission flags(s) to enable. +Specifies permission flags(s) to enable. Please visit https://docs.microsoft.com/previous-versions/office/sharepoint-csom/ee536458(v%3Doffice.15) for the PermissionKind enum ```yaml Type: PermissionKind[] @@ -131,4 +131,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteClassification.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteClassification.md index 7dae3bdda2..271cf19d19 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteClassification.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteClassification.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds one ore more site classification values to the list of possible values. Requires a connection to the Microsoft Graph. -## SYNTAX +## SYNTAX ```powershell Add-PnPSiteClassification -Classifications @@ -50,4 +50,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAdmin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAdmin.md index a1f06d201d..2036516842 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAdmin.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAdmin.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds one or more users as site collection administrators to the site collection in the current context -## SYNTAX +## SYNTAX ```powershell Add-PnPSiteCollectionAdmin -Owners @@ -71,4 +71,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAppCatalog.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAppCatalog.md index e3a0758a89..5c0757f8e0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAppCatalog.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteCollectionAppCatalog.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a Site Collection scoped App Catalog to a site -## SYNTAX +## SYNTAX ```powershell Add-PnPSiteCollectionAppCatalog -Site @@ -54,4 +54,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesign.md index ce955a7888..a9e236f56a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesign.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesign.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a new Site Design on the current tenant. -## SYNTAX +## SYNTAX ```powershell Add-PnPSiteDesign -Title @@ -132,4 +132,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesignTask.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesignTask.md index c703b002ea..cee9adf2ed 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesignTask.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteDesignTask.md @@ -11,7 +11,7 @@ schema: 2.0.0 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. -## SYNTAX +## SYNTAX ```powershell Add-PnPSiteDesignTask -SiteDesignId @@ -88,4 +88,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteScript.md index 8003c20203..9894bc8a30 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteScript.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPSiteScript.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a new Site Script on the current tenant. -## SYNTAX +## SYNTAX ```powershell Add-PnPSiteScript -Title @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPStoredCredential.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPStoredCredential.md index 8549ee9668..44b6b3a532 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPStoredCredential.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPStoredCredential.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a credential to the Windows Credential Manager -## SYNTAX +## SYNTAX ```powershell Add-PnPStoredCredential -Name @@ -62,7 +62,7 @@ Accept pipeline input: False ``` ### -Password -If not specified you will be prompted to enter your password. +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 ```yaml @@ -88,4 +88,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTaxonomyField.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTaxonomyField.md index bdac713098..eb1e68cca6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTaxonomyField.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTaxonomyField.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Add a taxonomy field -## SYNTAX +## SYNTAX ### Id ```powershell @@ -233,4 +233,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTeamsTeam.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTeamsTeam.md new file mode 100644 index 0000000000..d9d994100a --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTeamsTeam.md @@ -0,0 +1,47 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/add-pnpteamsteam +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Add-PnPTeamsTeam + +## SYNOPSIS +Adds a Teams team to an existing, group connected, site collection + +## SYNTAX + +```powershell +Add-PnPTeamsTeam [-Connection ] +``` + +## DESCRIPTION +This command allows you to add a Teams team to an existing, Office 365 group connected, site collection. + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Add-PnPTeamsTeam +``` + +This create a teams team for the connected site collection + +## PARAMETERS + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantCdnOrigin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantCdnOrigin.md index 9c47661ee7..6b526361d7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantCdnOrigin.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantCdnOrigin.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a new origin to the public or private content delivery network (CDN). -## SYNTAX +## SYNTAX ```powershell Add-PnPTenantCdnOrigin -OriginUrl @@ -74,4 +74,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequence.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequence.md index 937488a55c..170a703f4a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequence.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequence.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a tenant sequence object to a tenant template -## SYNTAX +## SYNTAX ```powershell Add-PnPTenantSequence -Template @@ -24,14 +24,14 @@ Add-PnPTenantSequence -Template Add-PnPTenantSequence -Template $mytemplate -Sequence $mysequence ``` -Adds an existing sequence object to an existing hierarchy object +Adds an existing sequence object to an existing template object ### ------------------EXAMPLE 2------------------ ```powershell New-PnPTenantSequence -Id "MySequence" | Add-PnPTenantSequence -Template $template ``` -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 hierarchy object +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 ## PARAMETERS @@ -53,7 +53,6 @@ The template to add the sequence to ```yaml Type: ProvisioningHierarchy Parameter Sets: __AllParameterSets -Aliases: Hierarchy Required: True Position: Named @@ -62,4 +61,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSite.md index bbd5ab54fa..ee088df7d7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a existing tenant sequence site object to a tenant template -## SYNTAX +## SYNTAX ```powershell Add-PnPTenantSequenceSite -Site @@ -24,7 +24,7 @@ Add-PnPTenantSequenceSite -Site Add-PnPTenantSequenceSite -Site $myteamsite -Sequence $mysequence ``` -Adds an existing site object to an existing hierarchy sequence +Adds an existing site object to an existing template sequence ## PARAMETERS @@ -54,4 +54,4 @@ Accept pipeline input: True ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSubSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSubSite.md index 152c445724..d8804ecc1f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSubSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantSequenceSubSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a tenant sequence sub site object to a tenant sequence site object -## SYNTAX +## SYNTAX ```powershell Add-PnPTenantSequenceSubSite -SubSite @@ -54,4 +54,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantTheme.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantTheme.md index 999b571c86..6a40edf80c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantTheme.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPTenantTheme.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds or updates a theme to the tenant. -## SYNTAX +## SYNTAX ```powershell Add-PnPTenantTheme -Identity @@ -110,4 +110,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPUserToGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPUserToGroup.md index 1560e16995..387c3ee863 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPUserToGroup.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPUserToGroup.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a user to a group -## SYNTAX +## SYNTAX ### Internal ```powershell @@ -140,4 +140,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPView.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPView.md index 0d099a9cd3..ba039b8f94 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPView.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPView.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a view to a list -## SYNTAX +## SYNTAX ```powershell Add-PnPView -List @@ -22,6 +22,7 @@ Add-PnPView -List [-Personal []] [-SetAsDefault []] [-Paged []] + [-Aggregations ] [-Web ] [-Connection ] ``` @@ -42,8 +43,29 @@ Add-PnPView -List "Demo List" -Title "Demo View" -Fields "Title","Address" -Page Adds a view named "Demo view" to the "Demo List" list and makes sure there's paging on this view. +### ------------------EXAMPLE 3------------------ +```powershell +Add-PnPView -List "Demo List" -Title "Demo View" -Fields "Title","Address" -Aggregations "" +``` + +Adds a view named "Demo view" to the "Demo List" list and sets the totals (aggregations) to Count on the Title field. + ## PARAMETERS +### -Aggregations +A valid XML fragment containing one or more Aggregations + +Only applicable to: SharePoint Online + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -Fields A list of fields to add. @@ -182,4 +204,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWebPartPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWebPartPage.md index 0bdf570fb6..883a239209 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWebPartPage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWebPartPage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a web part to a web part page in a specified zone -## SYNTAX +## SYNTAX ### XML ```powershell @@ -36,14 +36,14 @@ Add-PnPWebPartToWebPartPage -Path ### ------------------EXAMPLE 1------------------ ```powershell -Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Path "c:\myfiles\listview.webpart" -ZoneId "Header" -ZoneIndex 1 +Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Path "c:\myfiles\listview.webpart" -ZoneId "Header" -ZoneIndex 1 ``` 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 ### ------------------EXAMPLE 2------------------ ```powershell -Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -XML $webpart -ZoneId "Header" -ZoneIndex 1 +Add-PnPWebPartToWebPartPage -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -XML $webpart -ZoneId "Header" -ZoneIndex 1 ``` 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 @@ -137,4 +137,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWikiPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWikiPage.md index 0e3b6c217b..8d721272cf 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWikiPage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebPartToWikiPage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a web part to a wiki page in a specified table row and column -## SYNTAX +## SYNTAX ### XML ```powershell @@ -151,4 +151,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebhookSubscription.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebhookSubscription.md index 128491b422..c1869aaf11 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebhookSubscription.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWebhookSubscription.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a new Webhook subscription -## SYNTAX +## SYNTAX ```powershell Add-PnPWebhookSubscription -NotificationUrl @@ -124,4 +124,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWikiPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWikiPage.md index 9bcb2119da..f2445d45bb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWikiPage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWikiPage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a wiki page -## SYNTAX +## SYNTAX ### WithContent ```powershell @@ -102,4 +102,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowDefinition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowDefinition.md index 3a681bf39f..12e7186a01 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowDefinition.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowDefinition.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a workflow definition -## SYNTAX +## SYNTAX ```powershell Add-PnPWorkflowDefinition -Definition @@ -86,4 +86,4 @@ Returns the Id of the workflow definition ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowSubscription.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowSubscription.md index 23ce9ac58f..ff6cc0d3c0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowSubscription.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPWorkflowSubscription.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a workflow subscription to a list -## SYNTAX +## SYNTAX ```powershell Add-PnPWorkflowSubscription -Name @@ -185,4 +185,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPProvisioningTemplate.md index 355138458d..d870fcafd7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPProvisioningTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPProvisioningTemplate.md @@ -10,11 +10,12 @@ schema: 2.0.0 ## SYNOPSIS Applies a site template to a web -## SYNTAX +## SYNTAX ### Instance ```powershell Apply-PnPProvisioningTemplate [-InputInstance ] + [-TemplateId ] [-ResourceFolder ] [-OverwriteSystemPropertyBagValues []] [-IgnoreDuplicateDataRowErrors []] @@ -33,6 +34,7 @@ Apply-PnPProvisioningTemplate [-InputInstance ] ### Path ```powershell Apply-PnPProvisioningTemplate -Path + [-TemplateId ] [-ResourceFolder ] [-OverwriteSystemPropertyBagValues []] [-IgnoreDuplicateDataRowErrors []] @@ -111,6 +113,13 @@ Apply-PnPProvisioningTemplate -Path .\ -InputInstance $template Applies a site template from an in-memory instance of a ProvisioningTemplate type of the PnP Core Component, reading the supporting files, if any, from the current (.\) path. The syntax can be used together with any other supported parameters. +### ------------------EXAMPLE 9------------------ +```powershell +Apply-PnPProvisioningTemplate -Path .\template.xml -TemplateId "MyTemplate" +``` + +Applies the ProvisioningTemplate with the ID "MyTemplate" located in the template definition file template.xml. + ## PARAMETERS ### -ClearNavigation @@ -257,6 +266,18 @@ Position: Named Accept pipeline input: False ``` +### -TemplateId +ID of the template to use from the xml file containing the provisioning template. If not specified and multiple ProvisioningTemplate elements exist, the last one will be used. + +```yaml +Type: String +Parameter Sets: __AllParameterSets + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -TemplateProviderExtensions Allows you to specify ITemplateProviderExtension to execute while applying a template. @@ -295,4 +316,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPTenantTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPTenantTemplate.md index 5bc3361a40..a0ca987300 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPTenantTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Apply-PnPTenantTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Applies a tenant template to the current tenant. You must be a SharePoint Online global administrator to run the cmdlet. -## SYNTAX +## SYNTAX ### By Path ```powershell @@ -27,6 +27,7 @@ Apply-PnPTenantTemplate -Path [-ProvisionContentTypesToSubWebs []] [-ProvisionFieldsToSubWebs []] [-ClearNavigation []] + [-Configuration ] [-Connection ] ``` @@ -45,6 +46,7 @@ Apply-PnPTenantTemplate -Template [-ProvisionContentTypesToSubWebs []] [-ProvisionFieldsToSubWebs []] [-ClearNavigation []] + [-Configuration ] [-Connection ] ``` @@ -87,6 +89,18 @@ Position: Named Accept pipeline input: False ``` +### -Configuration +Specify a JSON configuration file to configure the extraction progress. + +```yaml +Type: ApplyConfigurationPipeBind +Parameter Sets: __AllParameterSets + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -ExcludeHandlers Allows you to run all handlers, excluding the ones specified. @@ -148,7 +162,7 @@ Accept pipeline input: False ``` ### -Parameters -Allows you to specify parameters that can be referred to in the hierarchy by means of the {parameter:<Key>} token. See examples on how to use this parameter. +Allows you to specify parameters that can be referred to in the tenant template by means of the {parameter:<Key>} token. See examples on how to use this parameter. ```yaml Type: Hashtable @@ -160,7 +174,7 @@ Accept pipeline input: False ``` ### -Path -Path to the xml or pnp file containing the provisioning hierarchy. +Path to the xml or pnp file containing the tenant template. ```yaml Type: String @@ -225,7 +239,6 @@ Accept pipeline input: False ```yaml Type: ProvisioningHierarchy Parameter Sets: By Object -Aliases: Hierarchy Required: True Position: 0 @@ -258,4 +271,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Approve-PnPTenantServicePrincipalPermissionRequest.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Approve-PnPTenantServicePrincipalPermissionRequest.md index 1d5b3de4d9..a37b44f851 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Approve-PnPTenantServicePrincipalPermissionRequest.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Approve-PnPTenantServicePrincipalPermissionRequest.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Approves a permission request for the current tenant's "SharePoint Online Client" service principal -## SYNTAX +## SYNTAX ```powershell Approve-PnPTenantServicePrincipalPermissionRequest -RequestId @@ -67,4 +67,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPDefaultColumnValues.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPDefaultColumnValues.md index 36c5ae8252..fd41d2a92d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPDefaultColumnValues.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPDefaultColumnValues.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Clear default column values for a document library -## SYNTAX +## SYNTAX ```powershell Clear-PnPDefaultColumnValues -List @@ -103,4 +103,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPListItemAsRecord.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPListItemAsRecord.md index 008cd56b32..4cc4c6b59f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPListItemAsRecord.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPListItemAsRecord.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Undeclares a list item as a record -## SYNTAX +## SYNTAX ```powershell Clear-PnPListItemAsRecord -List @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPTenantRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPTenantRecycleBinItem.md index 278a84c2af..eb9d61d350 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPTenantRecycleBinItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnPTenantRecycleBinItem.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Permanently deletes a site collection from the tenant scoped recycle bin -## SYNTAX +## SYNTAX ```powershell Clear-PnPTenantRecycleBinItem -Url @@ -98,4 +98,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnpRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnpRecycleBinItem.md index f7dd69ad27..1e86b81297 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnpRecycleBinItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Clear-PnpRecycleBinItem.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Permanently deletes all or a specific recycle bin item -## SYNTAX +## SYNTAX ### All ```powershell @@ -116,4 +116,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Connect-PnPOnline.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Connect-PnPOnline.md index 70b12d1f4a..bc8b015d3d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Connect-PnPOnline.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Connect-PnPOnline.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Connect to a SharePoint site -## SYNTAX +## SYNTAX ### Main ```powershell @@ -19,6 +19,7 @@ Connect-PnPOnline -Url [-Credentials ] [-CurrentCredentials []] [-UseAdfs []] + [-UseAdfsCert []] [-Kerberos []] [-LoginProviderName ] [-MinimalHealthScore ] @@ -54,12 +55,14 @@ Connect-PnPOnline -AccessToken ```powershell Connect-PnPOnline -Graph [] [-LaunchBrowser []] + [-IgnoreSslErrors []] [-NoTelemetry []] ``` ### Microsoft Graph using Scopes ```powershell Connect-PnPOnline -Scopes + [-IgnoreSslErrors []] [-NoTelemetry []] ``` @@ -150,19 +153,35 @@ Connect-PnPOnline -Url [-NoTelemetry []] ``` -### Microsoft Graph using Azure Active Directory +### App-Only with Azure Active Directory ```powershell -Connect-PnPOnline -AppId - -AppSecret - -AADDomain +Connect-PnPOnline -Url + -ClientId + -Tenant + [-ReturnConnection []] + [-MinimalHealthScore ] + [-RetryCount ] + [-RetryWait ] + [-RequestTimeout ] + [-CreateDrive []] + [-DriveName ] + [-CertificatePath ] + [-CertificateBase64Encoded ] + [-Certificate ] + [-CertificatePassword ] + [-AzureEnvironment ] + [-Scopes ] + [-TenantAdminUrl ] + [-SkipTenantAdminCheck []] + [-IgnoreSslErrors []] [-NoTelemetry []] ``` -### High Trust using a X509Certificate2 object. +### App-Only with Azure Active Directory using X502 certificates ```powershell Connect-PnPOnline -Url -ClientId - -HighTrustCertificate + -Tenant [-ReturnConnection []] [-MinimalHealthScore ] [-RetryCount ] @@ -170,19 +189,27 @@ Connect-PnPOnline -Url [-RequestTimeout ] [-CreateDrive []] [-DriveName ] + [-AzureEnvironment ] [-TenantAdminUrl ] [-SkipTenantAdminCheck []] [-IgnoreSslErrors []] - [-HighTrustCertificateIssuerId ] [-NoTelemetry []] ``` -### App-Only with Azure Active Directory +### Microsoft Graph using Azure Active Directory +```powershell +Connect-PnPOnline -AppId + -AppSecret + -AADDomain + [-IgnoreSslErrors []] + [-NoTelemetry []] +``` + +### High Trust using a X509Certificate2 object. ```powershell Connect-PnPOnline -Url -ClientId - -Tenant - -CertificatePath + -HighTrustCertificate [-ReturnConnection []] [-MinimalHealthScore ] [-RetryCount ] @@ -190,12 +217,10 @@ Connect-PnPOnline -Url [-RequestTimeout ] [-CreateDrive []] [-DriveName ] - [-CertificatePassword ] - [-AzureEnvironment ] - [-Scopes ] [-TenantAdminUrl ] [-SkipTenantAdminCheck []] [-IgnoreSslErrors []] + [-HighTrustCertificateIssuerId ] [-NoTelemetry []] ``` @@ -278,7 +303,7 @@ This will prompt for username and password and creates a context for the other P Connect-PnPOnline -Url https://contoso.sharepoint.com -Credentials (Get-Credential) ``` -This will prompt for username and password and creates a context for the other PowerShell commands to use. +This will prompt for username and password and creates a context for the other PowerShell commands to use. ### ------------------EXAMPLE 3------------------ ```powershell @@ -303,6 +328,13 @@ This will prompt for username and password and creates a context using ADFS to a ### ------------------EXAMPLE 6------------------ ```powershell +Connect-PnPOnline -Url http://yourlocalserver -UseAdfsCert +``` + +This will enable you to select a certificate to create a context using ADFS to authenticate. + +### ------------------EXAMPLE 7------------------ +```powershell Connect-PnPOnline -Url https://yourserver -Credentials (Get-Credential) -CreateDrive cd SPO:\\ dir @@ -310,63 +342,63 @@ dir This will prompt you for credentials and creates a context for the other PowerShell commands to use. It will also create a SPO:\\ drive you can use to navigate around the site -### ------------------EXAMPLE 7------------------ +### ------------------EXAMPLE 8------------------ ```powershell Connect-PnPOnline -Url https://yourserver -Credentials (Get-Credential) -AuthenticationMode FormsAuthentication ``` This will prompt you for credentials and creates a context for the other PowerShell commands to use. It assumes your server is configured for Forms Based Authentication (FBA) -### ------------------EXAMPLE 8------------------ +### ------------------EXAMPLE 9------------------ ```powershell Connect-PnPOnline -Url https://contoso.sharepoint.de -AppId 344b8aab-389c-4e4a-8fa1-4c1ae2c0a60d -AppSecret a3f3faf33f3awf3a3sfs3f3ss3f4f4a3fawfas3ffsrrffssfd -AzureEnvironment Germany ``` This will authenticate you to the German Azure environment using the German Azure endpoints for authentication -### ------------------EXAMPLE 9------------------ +### ------------------EXAMPLE 10------------------ ```powershell Connect-PnPOnline -Url https://contoso.sharepoint.com -SPOManagementShell ``` This will authenticate you using the SharePoint Online Management Shell application -### ------------------EXAMPLE 10------------------ +### ------------------EXAMPLE 11------------------ ```powershell Connect-PnPOnline -Url https://contoso.sharepoint.com -PnPO365ManagementShell ``` This will authenticate you using the PnP O365 Management Shell Multi-Tenant application. A browser window will have to be opened where you have to enter a code that is shown in your PowerShell window. -### ------------------EXAMPLE 11------------------ +### ------------------EXAMPLE 12------------------ ```powershell Connect-PnPOnline -Url https://contoso.sharepoint.com -PnPO365ManagementShell -LaunchBrowser ``` This will authenticate you using the PnP O365 Management Shell Multi-Tenant application. A browser window will automatically open and the code you need to enter will be automatically copied to your clipboard. -### ------------------EXAMPLE 12------------------ +### ------------------EXAMPLE 13------------------ ```powershell Connect-PnPOnline -Url https://contoso.sharepoint.com -AccessToken $myaccesstoken ``` This will authenticate you using the provided access token -### ------------------EXAMPLE 13------------------ +### ------------------EXAMPLE 14------------------ ```powershell -Connect-PnPOnline -Scopes $arrayOfScopes +Connect-PnPOnline -Scopes "Mail.Read","Files.Read" ``` -Connects to Azure AD and gets and OAuth 2.0 Access Token to consume the Microsoft Graph API including the declared permission scopes. The available permission scopes are defined at the following URL: https://graph.microsoft.io/en-us/docs/authorization/permission_scopes +Connects to Azure AD and gets and OAuth 2.0 Access Token to consume the Microsoft Graph API including the declared permission scopes. The available permission scopes are defined at the following URL: https://docs.microsoft.com/en-us/graph/permissions-reference -### ------------------EXAMPLE 14------------------ +### ------------------EXAMPLE 15------------------ ```powershell Connect-PnPOnline -AppId '' -AppSecret '' -AADDomain 'contoso.onmicrosoft.com' ``` Connects to the Microsoft Graph API using application permissions via an app's declared permission scopes. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/Graph.ConnectUsingAppPermissions for a sample on how to get started. -### ------------------EXAMPLE 15------------------ +### ------------------EXAMPLE 16------------------ ```powershell certutil.exe -csp 'Microsoft Enhanced RSA and AES Cryptographic Provider' -v -p 'password' -importpfx -user c:\HighTrust.pfx NoRoot Connect-PnPOnline -Url https://yourserver -ClientId -HighTrustCertificate (Get-Item Cert:\CurrentUser\My\) @@ -374,20 +406,62 @@ Connect-PnPOnline -Url https://yourserver -ClientId -HighTrustCertificate ( Connect to an on-premises SharePoint environment using a high trust certificate, stored in the Personal certificate store of the current user. -### ------------------EXAMPLE 16------------------ +### ------------------EXAMPLE 17------------------ ```powershell -Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '' -Tenant 'contoso.onmicrosoft.com' -PEMCertificate -PEMPrivateKey +Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '' -Tenant 'contoso.onmicrosoft.com' -CertificatePath c:\absolute-path\to\pnp.pfx -CertificatePassword ``` 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. -### ------------------EXAMPLE 17------------------ +### ------------------EXAMPLE 18------------------ +```powershell +Connect-PnPOnline -ClientId -CertificatePath 'c:\mycertificate.pfx' -CertificatePassword (ConvertTo-SecureString -AsPlainText 'myprivatekeypassword' -Force) -Url https://contoso.sharepoint.com -Tenant 'contoso.onmicrosoft.com' +``` + +Connects using an Azure Active Directory registered application using a locally available certificate containing a private key. See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread for a sample on how to get started. + +### ------------------EXAMPLE 19------------------ ```powershell Connect-PnPOnline -Url https://yourserver -ClientId 763d5e60-b57e-426e-8e87-b7258f7f8188 -HighTrustCertificatePath c:\HighTrust.pfx -HighTrustCertificatePassword 'password' -HighTrustCertificateIssuerId 6b9534d8-c2c1-49d6-9f4b-cd415620bca8 ``` Connect to an on-premises SharePoint environment using a high trust certificate stored in a .PFX file. +### ------------------EXAMPLE 20------------------ +```powershell +Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '' -Tenant 'contoso.onmicrosoft.com' -Thumbprint 34CFAA860E5FB8C44335A38A097C1E41EEA206AA +``` + +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. + +### ------------------EXAMPLE 21------------------ +```powershell +Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '' -Tenant 'contoso.onmicrosoft.com' -PEMCertificate -PEMPrivateKey -CertificatePassword +``` + +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. + +### ------------------EXAMPLE 22------------------ +```powershell +Connect-PnPOnline -ClientId -CertificateBase64Encoded 'xxxx' -CertificatePassword (ConvertTo-SecureString -AsPlainText 'myprivatekeypassword' -Force) -Url https://contoso.sharepoint.com -Tenant 'contoso.onmicrosoft.com' +``` + +Connects using an Azure Active Directory registered application using a certificate containing a private key encoded in base 64 such as received in an Azure Function when using Azure KeyVault. See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread for a sample on how to get started. + +### ------------------EXAMPLE 23------------------ +```powershell +Connect-PnPOnline -Url https://contoso.sharepoint.com -ClientId '' -Tenant 'contoso.onmicrosoft.com' -Certificate +``` + +Connects to SharePoint using app-only auth in combination with a certificate. See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread#using-this-principal-in-your-powershell-script-using-the-pnp-sites-core-library for a sample on how to get started. + +### ------------------EXAMPLE 24------------------ +```powershell +Connect-PnPOnline -ClientId -Certificate $cert -CertificatePassword (ConvertTo-SecureString -AsPlainText 'myprivatekeypassword' -Force) -Url https://contoso.sharepoint.com -Tenant 'contoso.onmicrosoft.com' +``` + +Connects using an Azure Active Directory registered application using a certificate instance containing a private key. See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread for a sample on how to get started. + ## PARAMETERS ### -AADDomain @@ -461,7 +535,35 @@ Only applicable to: SharePoint Online ```yaml Type: AzureEnvironment -Parameter Sets: Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint +Parameter Sets: Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Certificate +X509Certificate2 reference containing the private key to authenticate the requests to SharePoint Online + +Only applicable to: SharePoint Online + +```yaml +Type: X509Certificate2 +Parameter Sets: App-Only with Azure Active Directory + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -CertificateBase64Encoded +Base64 Encoded X509Certificate2 certificate containing the private key to authenticate the requests to SharePoint Online such as retrieved in Azure Functions from Azure KeyVault + +Only applicable to: SharePoint Online + +```yaml +Type: String +Parameter Sets: App-Only with Azure Active Directory Required: False Position: Named @@ -483,7 +585,7 @@ Accept pipeline input: False ``` ### -CertificatePath -Path to the certificate (*.pfx) +Path to the certificate containing the private key (*.pfx) Only applicable to: SharePoint Online @@ -491,7 +593,7 @@ Only applicable to: SharePoint Online Type: String Parameter Sets: App-Only with Azure Active Directory -Required: True +Required: False Position: Named Accept pipeline input: False ``` @@ -515,7 +617,7 @@ The Client ID of the Azure AD Application ```yaml Type: String -Parameter Sets: Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint +Parameter Sets: Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates Required: True Position: Named @@ -527,7 +629,7 @@ If you want to create a PSDrive connected to the URL ```yaml Type: SwitchParameter -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, SPO Management Shell Credentials, Access Token +Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token Required: False Position: Named @@ -535,7 +637,7 @@ Accept pipeline input: False ``` ### -Credentials -Credentials of the user to connect with. Either specify a PSCredential object or a string. In case of a string value a lookup will be done to the Windows Credential Manager for the correct credentials. +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. ```yaml Type: CredentialPipeBind @@ -563,7 +665,7 @@ Name of the PSDrive to create (default: SPO) ```yaml Type: String -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, SPO Management Shell Credentials, Access Token +Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token Required: False Position: Named @@ -655,7 +757,7 @@ Ignores any SSL errors. To be used i.e. when connecting to a SharePoint farm usi ```yaml Type: SwitchParameter -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, SPO Management Shell Credentials +Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, Microsoft Graph using Azure Active Directory, Microsoft Graph using Scopes, PnP Office 365 Management Shell to the Microsoft Graph, SPO Management Shell Credentials Required: False Position: Named @@ -705,7 +807,7 @@ Specifies a minimal server healthscore before any requests are executed. ```yaml Type: Int -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, SPO Management Shell Credentials, Access Token +Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token Required: False Position: Named @@ -806,7 +908,7 @@ The request timeout. Default is 1800000 ```yaml Type: Int -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, SPO Management Shell Credentials, Access Token +Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token Required: False Position: Named @@ -818,7 +920,7 @@ Defines how often a retry should be executed if the server healthscore is not su ```yaml Type: Int -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, SPO Management Shell Credentials, Access Token +Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token Required: False Position: Named @@ -830,7 +932,7 @@ Defines how many seconds to wait before each retry. Default is 1 second. ```yaml Type: Int -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, SPO Management Shell Credentials, Access Token +Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token Required: False Position: Named @@ -842,7 +944,7 @@ Returns the connection for use with the -Connection parameter on cmdlets. ```yaml Type: SwitchParameter -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, SPO Management Shell Credentials, Access Token, PnP O365 Management Shell / DeviceLogin +Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token, PnP O365 Management Shell / DeviceLogin Required: False Position: Named @@ -868,7 +970,7 @@ Should we skip the check if this site is the Tenant admin site. Default is false ```yaml Type: SwitchParameter -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, SPO Management Shell Credentials, Access Token +Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials, Access Token Required: False Position: Named @@ -896,7 +998,7 @@ Only applicable to: SharePoint Online ```yaml Type: String -Parameter Sets: App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory +Parameter Sets: App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory, App-Only with Azure Active Directory using X502 certificates Required: True Position: Named @@ -908,7 +1010,7 @@ The url to the Tenant Admin site. If not specified, the cmdlets will assume to c ```yaml Type: String -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, SPO Management Shell Credentials +Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, App-Only with Azure Active Directory using X502 certificates, SPO Management Shell Credentials Required: False Position: Named @@ -934,7 +1036,7 @@ The Url of the site collection to connect to. ```yaml Type: String -Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, SPO Management Shell Credentials, Access Token, PnP O365 Management Shell / DeviceLogin +Parameter Sets: Main, Token, WebLogin, Azure Active Directory, App-Only with Azure Active Directory, App-Only with Azure Active Directory using certificate as PEM strings, App-Only with Azure Active Directory using X502 certificates, App-Only with Azure Active Directory using certificate from certificate store by thumbprint, SPO Management Shell Credentials, Access Token, PnP O365 Management Shell / DeviceLogin Required: True Position: 0 @@ -953,6 +1055,18 @@ Position: Named Accept pipeline input: False ``` +### -UseAdfsCert +If you want to connect to your SharePoint farm using ADFS with Certificate Authentication + +```yaml +Type: SwitchParameter +Parameter Sets: Main + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -UseWebLogin If you want to connect to SharePoint with browser based login. This is required when you have multi-factor authentication (MFA) enabled. @@ -967,4 +1081,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPFolderToProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPFolderToProvisioningTemplate.md index 7d8989adf9..ab5bfb9612 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPFolderToProvisioningTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPFolderToProvisioningTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a pnp package file of an existing template xml, and includes all files in the current folder -## SYNTAX +## SYNTAX ```powershell Convert-PnPFolderToProvisioningTemplate -Out @@ -74,4 +74,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPProvisioningTemplate.md index 8f105450bf..8eb878dc02 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPProvisioningTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Convert-PnPProvisioningTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Converts a provisioning template to an other schema version -## SYNTAX +## SYNTAX ```powershell Convert-PnPProvisioningTemplate -Path @@ -107,4 +107,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Encoding](https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Encoding](https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/ConvertTo-PnPClientSidePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/ConvertTo-PnPClientSidePage.md index 0a917e5951..dc8ec9ca7b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/ConvertTo-PnPClientSidePage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/ConvertTo-PnPClientSidePage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Converts a classic page (wiki or web part page) into a Client-Side Page -## SYNTAX +## SYNTAX ```powershell ConvertTo-PnPClientSidePage -Identity @@ -23,8 +23,11 @@ ConvertTo-PnPClientSidePage -Identity [-AddPageAcceptBanner []] [-SkipItemLevelPermissionCopyToClientSidePage []] [-SkipUrlRewriting []] + [-SkipDefaultUrlRewriting []] + [-UrlMappingFile ] [-ClearCache []] [-CopyPageMetadata []] + [-AddTableListImageAsImageWebPart []] [-UseCommunityScriptEditor []] [-SummaryLinksToHtml []] [-TargetWebUrl ] @@ -33,11 +36,23 @@ ConvertTo-PnPClientSidePage -Identity [-LogSkipFlush []] [-LogVerbose []] [-DontPublish []] + [-KeepPageCreationModificationInformation []] + [-SetAuthorInPageHeader []] + [-PostAsNews []] [-DisablePageComments []] [-PublishingPage []] + [-BlogPage []] + [-DelveBlogPage []] + [-DelveKeepSubTitle []] [-PageLayoutMapping ] [-PublishingTargetPageName ] + [-TargetPageName ] + [-TargetPageFolder ] + [-TargetPageFolderOverridesDefaultFolder []] [-TargetConnection ] + [-SkipUserMapping []] + [-UserMappingFile ] + [-LDAPConnectionString ] [-Web ] [-Connection ] ``` @@ -49,28 +64,28 @@ ConvertTo-PnPClientSidePage -Identity ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -Overwrite ``` -Converts a wiki page named 'somepage' to a client side page +Converts a wiki/web part page named 'somepage' to a client side page ### ------------------EXAMPLE 2------------------ ```powershell ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -Overwrite -WebPartMappingFile c:\contoso\webpartmapping.xml ``` -Converts a wiki page named 'somepage' to a client side page using a custom provided mapping file +Converts a wiki/web part page named 'somepage' to a client side page using a custom provided mapping file ### ------------------EXAMPLE 3------------------ ```powershell ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -Overwrite -AddPageAcceptBanner ``` -Converts a wiki 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 +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 ### ------------------EXAMPLE 4------------------ ```powershell ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -Overwrite -CopyPageMetadata ``` -Converts a wiki page named 'somepage' to a client side page, including the copying of the page metadata (if any) +Converts a wiki/web part page named 'somepage' to a client side page, including the copying of the page metadata (if any) ### ------------------EXAMPLE 5------------------ ```powershell @@ -105,21 +120,42 @@ Converts a web part page named 'somepage' living inside the root of the site col ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -Overwrite -TargetWebUrl https://contoso.sharepoint.com/sites/targetmodernsite ``` -Converts a wiki page named 'somepage' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site +Converts a wiki/web part page named 'somepage' to a client side page in the https://contoso.sharepoint.com/sites/targetmodernsite site ### ------------------EXAMPLE 10------------------ ```powershell ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -LogType File -LogFolder c:\temp -LogVerbose -Overwrite ``` -Converts a web part page named 'somepage' and creates a log file in c: emp using verbose logging +Converts a wiki/web part page named 'somepage' and creates a log file in c:\temp using verbose logging ### ------------------EXAMPLE 11------------------ ```powershell ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -LogType SharePoint -LogSkipFlush ``` -Converts a web part page named 'somepage' and creates a log file in SharePoint but skip the actual write. Use this option to make multiple ConvertTo-PnPClientSidePage invocations create a single log +Converts a wiki/web part page named 'somepage' and creates a log file in SharePoint but skip the actual write. Use this option to make multiple ConvertTo-PnPClientSidePage invocations create a single log + +### ------------------EXAMPLE 12------------------ +```powershell +ConvertTo-PnPClientSidePage -Identity "My post title" -BlogPage -LogType Console -Overwrite -TargetWebUrl https://contoso.sharepoint.com/sites/targetmodernsite +``` + +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 + +### ------------------EXAMPLE 13------------------ +```powershell +ConvertTo-PnPClientSidePage -Identity "My post title" -DelveBlogPage -LogType Console -Overwrite -TargetWebUrl https://contoso.sharepoint.com/sites/targetmodernsite +``` + +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 + +### ------------------EXAMPLE 14------------------ +```powershell +ConvertTo-PnPClientSidePage -Identity "somepage.aspx" -PublishingPage -Overwrite -TargetConnection $target -UserMappingFile c:\\temp\user_mapping_file.csv +``` + +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. ## PARAMETERS @@ -135,6 +171,30 @@ Position: Named Accept pipeline input: False ``` +### -AddTableListImageAsImageWebPart +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 + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -BlogPage +I'm transforming a blog page + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -ClearCache 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 @@ -159,6 +219,30 @@ Position: Named Accept pipeline input: False ``` +### -DelveBlogPage +I'm transforming a Delve blog page + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -DelveKeepSubTitle +Transform the possible sub title as topic header on the modern page + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -DisablePageComments Disable comments for the created modern page @@ -207,6 +291,30 @@ Position: 0 Accept pipeline input: True ``` +### -KeepPageCreationModificationInformation +Keep the author, editor, created and modified information from the source page (when source page lives in SPO) + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -LDAPConnectionString +Specifies a LDAP connection string e.g. LDAP://OU=Users,DC=Contoso,DC=local + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -Library The name of the library containing the page. If SitePages then please omit this parameter @@ -291,6 +399,18 @@ Position: Named Accept pipeline input: True ``` +### -PostAsNews +Post the created, and published, modern page as news + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -PublishingPage I'm transforming a publishing page @@ -327,6 +447,30 @@ Position: Named Accept pipeline input: False ``` +### -SetAuthorInPageHeader +Set's the author of the source page as author in the modern page header (when source page lives in SPO) + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -SkipDefaultUrlRewriting +Set this flag to prevent the default URL rewriting while you still want to do URL rewriting using a custom URL mapping file + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -SkipItemLevelPermissionCopyToClientSidePage By default the item level permissions on a page are copied to the created client side page. Use this switch to prevent the copy @@ -351,6 +495,18 @@ Position: Named Accept pipeline input: False ``` +### -SkipUserMapping +Disables user mapping during transformation + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -SummaryLinksToHtml By default summarylinks web parts are replaced by QuickLinks, but you can transform to plain html by setting this switch @@ -387,6 +543,42 @@ Position: Named Accept pipeline input: False ``` +### -TargetPageFolder +Folder to create the target page in (will be used in conjunction with auto-generated folders that ensure page name uniqueness) + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -TargetPageFolderOverridesDefaultFolder +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 + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -TargetPageName +Name for the target page (only applies when doing cross site page transformation) + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -TargetWebUrl Url of the target web that will receive the modern page. Defaults to null which means in-place transformation @@ -399,6 +591,18 @@ Position: Named Accept pipeline input: False ``` +### -UrlMappingFile +File holding custom URL mapping definitions + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -UseCommunityScriptEditor 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 @@ -411,6 +615,18 @@ Position: Named Accept pipeline input: False ``` +### -UserMappingFile +Specifies a user mapping file + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -WebPartMappingFile Path and name of the web part mapping file driving the transformation @@ -449,4 +665,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPFile.md index 33bde48f8b..4924e6a4c7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPFile.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPFile.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Copies a file or folder to a different location, currently there is a 200MB file size limit for the file to be copied. -## SYNTAX +## SYNTAX ### SOURCEURL ```powershell @@ -44,7 +44,7 @@ Copies a file named company.docx located in a document library called Documents PS:>Copy-PnPFile -SourceUrl Documents/company.docx -TargetUrl Documents2/company.docx ``` -Copies a file named company.docx located in a document library called Documents to a document library called Documents2 in the same site. +Copies a file named company.docx located in a document library called Documents to a document library called Documents2 in the same site. ### ------------------EXAMPLE 4------------------ ```powershell @@ -191,4 +191,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPItemProxy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPItemProxy.md index ebfe90f388..7d254700ab 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPItemProxy.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Copy-PnPItemProxy.md @@ -12,4 +12,4 @@ Proxy cmdlet for using Copy-Item between SharePoint provider and FileSystem prov ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Deny-PnPTenantServicePrincipalPermissionRequest.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Deny-PnPTenantServicePrincipalPermissionRequest.md index 574a7e5dc6..3c31419112 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Deny-PnPTenantServicePrincipalPermissionRequest.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Deny-PnPTenantServicePrincipalPermissionRequest.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Denies a permission request for the current tenant's "SharePoint Online Client" service principal -## SYNTAX +## SYNTAX ```powershell Deny-PnPTenantServicePrincipalPermissionRequest -RequestId @@ -63,4 +63,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPFeature.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPFeature.md index 7615a0b195..d15b6b0667 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPFeature.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPFeature.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Disables a feature -## SYNTAX +## SYNTAX ```powershell Disable-PnPFeature -Identity @@ -110,4 +110,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPInPlaceRecordsManagementForSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPInPlaceRecordsManagementForSite.md index 4589cc5e9d..e1e47d9fb6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPInPlaceRecordsManagementForSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPInPlaceRecordsManagementForSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Disables in place records management for a site. -## SYNTAX +## SYNTAX ```powershell Disable-PnPInPlaceRecordsManagementForSite [-Connection ] @@ -41,4 +41,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPPowerShellTelemetry.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPPowerShellTelemetry.md index a34a6a6491..e66518675d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPPowerShellTelemetry.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPPowerShellTelemetry.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Disables PnP PowerShell telemetry tracking -## SYNTAX +## SYNTAX ```powershell Disable-PnPPowerShellTelemetry [-Force []] @@ -51,4 +51,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPResponsiveUI.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPResponsiveUI.md index 5f3a4b26be..8d8e638cde 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPResponsiveUI.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPResponsiveUI.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Deactivate the PnP Response UI add-on -## SYNTAX +## SYNTAX ```powershell Disable-PnPResponsiveUI [-Web ] @@ -57,4 +57,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPSiteClassification.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPSiteClassification.md index 760c6117ed..7d8c46420e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPSiteClassification.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPSiteClassification.md @@ -22,4 +22,4 @@ Disables Site Classifications for your tenant. ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPTenantServicePrincipal.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPTenantServicePrincipal.md index 476acf4890..2c185f370b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPTenantServicePrincipal.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Disable-PnPTenantServicePrincipal.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Enables the current tenant's "SharePoint Online Client" service principal. -## SYNTAX +## SYNTAX ```powershell Disable-PnPTenantServicePrincipal [-Force []] @@ -48,4 +48,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Disconnect-PnPOnline.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Disconnect-PnPOnline.md index 20f6dfe79d..b0951521f2 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Disconnect-PnPOnline.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Disconnect-PnPOnline.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Disconnects the context -## SYNTAX +## SYNTAX ```powershell Disconnect-PnPOnline [-Connection ] @@ -44,4 +44,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPCommSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPCommSite.md index 87ff8965fe..5fe3d592ba 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPCommSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPCommSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Enable communication site on the root site of a tenant -## SYNTAX +## SYNTAX ```powershell Enable-PnPCommSite [-SiteUrl ] @@ -64,4 +64,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPFeature.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPFeature.md index db6f40a54c..22cd7ba667 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPFeature.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPFeature.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Enables a feature -## SYNTAX +## SYNTAX ```powershell Enable-PnPFeature -Identity @@ -120,4 +120,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPInPlaceRecordsManagementForSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPInPlaceRecordsManagementForSite.md index 6f16556c61..86706c15ae 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPInPlaceRecordsManagementForSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPInPlaceRecordsManagementForSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Enables in place records management for a site. -## SYNTAX +## SYNTAX ```powershell Enable-PnPInPlaceRecordsManagementForSite [-Connection ] @@ -41,4 +41,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPPowerShellTelemetry.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPPowerShellTelemetry.md index b1194ee1c1..ef38123c9c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPPowerShellTelemetry.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPPowerShellTelemetry.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Enables PnP PowerShell telemetry tracking. -## SYNTAX +## SYNTAX ```powershell Enable-PnPPowerShellTelemetry [-Force []] @@ -51,4 +51,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPResponsiveUI.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPResponsiveUI.md index 3ea6032451..63e742b6e4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPResponsiveUI.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPResponsiveUI.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Activates the PnP Response UI Add-on -## SYNTAX +## SYNTAX ```powershell Enable-PnPResponsiveUI [-InfrastructureSiteUrl ] @@ -70,4 +70,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPSiteClassification.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPSiteClassification.md index 7d67474d54..e4bbff0a9c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPSiteClassification.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPSiteClassification.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Enables Site Classifications for the tenant. Requires a connection to the Microsoft Graph. -## SYNTAX +## SYNTAX ```powershell Enable-PnPSiteClassification -Classifications @@ -76,4 +76,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPTenantServicePrincipal.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPTenantServicePrincipal.md index ad908ba60b..2f036db52a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPTenantServicePrincipal.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Enable-PnPTenantServicePrincipal.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Enables the current tenant's "SharePoint Online Client" service principal. -## SYNTAX +## SYNTAX ```powershell Enable-PnPTenantServicePrincipal [-Force []] @@ -48,4 +48,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPClientSidePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPClientSidePage.md index 5beadc6c87..c06cfcbbc6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPClientSidePage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPClientSidePage.md @@ -10,13 +10,14 @@ schema: 2.0.0 ## SYNOPSIS Exports a Client Side Page to a PnP Provisioning Template -## SYNTAX +## SYNTAX ```powershell Export-PnPClientSidePage -Identity [-PersistBrandingFiles []] [-Out ] [-Force []] + [-Configuration ] [-Web ] [-Connection ] ``` @@ -25,13 +26,25 @@ Export-PnPClientSidePage -Identity ### ------------------EXAMPLE 1------------------ ```powershell -Export-PnPClientSidePage -Identity Home.aspx +Export-PnPClientSidePage -Identity Home.aspx ``` Exports the page 'Home.aspx' to a new PnP Provisioning Template ## PARAMETERS +### -Configuration +Specify a JSON configuration file to configure the extraction progress. + +```yaml +Type: ExtractConfigurationPipeBind +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -Force Specify to override the question to overwrite a file if it already exists. @@ -106,4 +119,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPClientSidePageMapping.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPClientSidePageMapping.md index d2461552b0..6face56d67 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPClientSidePageMapping.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPClientSidePageMapping.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Get's the built-in maping files or a custom mapping file for your publishing portal page layouts. These mapping files are used to tailor the page transformation experience. -## SYNTAX +## SYNTAX ```powershell Export-PnPClientSidePageMapping [-BuiltInWebPartMapping []] @@ -20,6 +20,7 @@ Export-PnPClientSidePageMapping [-BuiltInWebPartMapping []] [-AnalyzeOOBPageLayouts []] [-Folder ] [-Overwrite []] + [-Logging []] [-Web ] [-Connection ] ``` @@ -109,6 +110,18 @@ Position: Named Accept pipeline input: False ``` +### -Logging +Outputs analyser logging to the console + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -Overwrite Overwrites existing mapping files @@ -159,4 +172,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPListToProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPListToProvisioningTemplate.md new file mode 100644 index 0000000000..b83c9c13f3 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPListToProvisioningTemplate.md @@ -0,0 +1,129 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/export-pnplisttoprovisioningtemplate +applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +schema: 2.0.0 +--- + +# Export-PnPListToProvisioningTemplate + +## SYNOPSIS +Exports one or more lists to provisioning template + +## SYNTAX + +```powershell +Export-PnPListToProvisioningTemplate -List + [-Out ] + [-Force []] + [-OutputInstance []] + [-Schema ] + [-Web ] + [-Connection ] +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Export-PnPListToProvisioningTemplate -Out template.xml -List "Documents" +``` + +Extracts a list to a new provisioning template including the list specified by title or ID. + +### ------------------EXAMPLE 2------------------ +```powershell +Export-PnPListToProvisioningTemplate -Out template.pnp -List "Documents","Events" +``` + +Extracts a list to a new provisioning template Office Open XML file, including the lists specified by title or ID. + +## PARAMETERS + +### -Force +Overwrites the output file if it exists. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -List +Specify the lists to extract, either providing their ID or their Title. + +```yaml +Type: String +Parameter Sets: (All) + +Required: True +Position: Named +Accept pipeline input: False +``` + +### -Out +Filename to write to, optionally including full path + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: 0 +Accept pipeline input: False +``` + +### -OutputInstance +Returns the template as an in-memory object, which is an instance of the ProvisioningTemplate type of the PnP Core Component. It cannot be used together with the -Out parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Schema +The schema of the output to use, defaults to the latest schema + +```yaml +Type: XMLPnPSchemaVersion +Parameter Sets: (All) + +Required: False +Position: 1 +Accept pipeline input: False +``` + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Web +This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. + +```yaml +Type: WebPipeBind +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTaxonomy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTaxonomy.md index d3dd339665..aa283f21da 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTaxonomy.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTaxonomy.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Exports a taxonomy to either the output or to a file. -## SYNTAX +## SYNTAX ### TermSet ```powershell @@ -43,14 +43,14 @@ Exports the full taxonomy the file output.txt ### ------------------EXAMPLE 3------------------ ```powershell -Export-PnPTaxonomy -Path c:\output.txt -TermSetId f6f43025-7242-4f7a-b739-41fa32847254 +Export-PnPTaxonomy -Path c:\output.txt -TermSet f6f43025-7242-4f7a-b739-41fa32847254 ``` Exports the term set with the specified id ### ------------------EXAMPLE 4------------------ ```powershell -Export-PnPTaxonomy -Path c:\output.txt -TermSetId f6f43025-7242-4f7a-b739-41fa32847254 -Lcid 1044 +Export-PnPTaxonomy -Path c:\output.txt -TermSet f6f43025-7242-4f7a-b739-41fa32847254 -Lcid 1044 ``` Exports the term set with the specified id using Norwegian labels @@ -167,4 +167,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTermGroupToXml.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTermGroupToXml.md index 5465beabc5..56ecc1be14 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTermGroupToXml.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Export-PnPTermGroupToXml.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Exports a taxonomy TermGroup to either the output or to an XML file. -## SYNTAX +## SYNTAX ```powershell Export-PnPTermGroupToXml [-Identity ] @@ -128,4 +128,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Find-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Find-PnPFile.md index 14bcb2796f..c366566262 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Find-PnPFile.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Find-PnPFile.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Finds a file in the virtual file system of the web. -## SYNTAX +## SYNTAX ### Web ```powershell @@ -126,4 +126,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAccessToken.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAccessToken.md index 06c34498d4..86c3571562 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAccessToken.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAccessToken.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the current OAuth Access token -## SYNTAX +## SYNTAX ```powershell Get-PnPAccessToken [-Decoded []] @@ -44,4 +44,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAlert.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAlert.md index f7057cb2ea..abc3202b8d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAlert.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAlert.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns registered alerts for a user. -## SYNTAX +## SYNTAX ```powershell Get-PnPAlert [-List ] @@ -124,4 +124,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPApp.md index c517c7b54b..bf3d535db1 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPApp.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPApp.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the available apps from the app catalog -## SYNTAX +## SYNTAX ```powershell Get-PnPApp [-Identity ] @@ -91,4 +91,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppAuthAccessToken.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppAuthAccessToken.md index 98bcb6c78d..c82ee9d920 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppAuthAccessToken.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppAuthAccessToken.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the access token -## SYNTAX +## SYNTAX ```powershell Get-PnPAppAuthAccessToken [-Connection ] @@ -48,4 +48,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppInstance.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppInstance.md index ab7a98af7b..619e415e58 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppInstance.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAppInstance.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Returns a SharePoint AddIn Instance -## SYNTAX +## SYNTAX +### ```powershell Get-PnPAppInstance [-Includes ] [-Identity ] @@ -94,4 +95,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPApplicationCustomizer.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPApplicationCustomizer.md new file mode 100644 index 0000000000..014f3487d4 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPApplicationCustomizer.md @@ -0,0 +1,170 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/get-pnpapplicationcustomizer +applicable: SharePoint Online, SharePoint 2019 +schema: 2.0.0 +--- + +# Get-PnPApplicationCustomizer + +## SYNOPSIS +Returns all SharePoint Framework client side extension application customizers + +## SYNTAX + +### Custom Action Id +```powershell +Get-PnPApplicationCustomizer [-Identity ] + [-Scope ] + [-ThrowExceptionIfCustomActionNotFound []] + [-Web ] + [-Connection ] +``` + +### +```powershell +Get-PnPApplicationCustomizer [-Includes ] + [-Scope ] + [-ThrowExceptionIfCustomActionNotFound []] + [-Web ] + [-Connection ] +``` + +### Client Side Component Id +```powershell +Get-PnPApplicationCustomizer -ClientSideComponentId + [-Scope ] + [-ThrowExceptionIfCustomActionNotFound []] + [-Web ] + [-Connection ] +``` + +## DESCRIPTION +Returns all SharePoint Framework client side extension application customizers registered on the current web and/or site + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Get-PnPApplicationCustomizer +``` + +Returns the custom action representing the SharePoint Framework client side extension registrations registered on the current site collection and web. + +### ------------------EXAMPLE 2------------------ +```powershell +Get-PnPApplicationCustomizer -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 +``` + +Returns the custom action representing the SharePoint Framework client side extension registration with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'. + +### ------------------EXAMPLE 3------------------ +```powershell +Get-PnPApplicationCustomizer -ClientSideComponentId aa66f67e-46c0-4474-8a82-42bf467d07f2 -Scope Web +``` + +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. + +## PARAMETERS + +### -ClientSideComponentId +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 + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: GuidPipeBind +Parameter Sets: Client Side Component Id + +Required: True +Position: Named +Accept pipeline input: False +``` + +### -Identity +Identity of the SharePoint Framework client side extension application customizer to return. Omit to return all SharePoint Frameworkclient side extension application customizer. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: GuidPipeBind +Parameter Sets: Custom Action Id + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Includes +Specify properties to include when retrieving objects from the server. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: String[] +Parameter Sets: (All) + +Required: False +Position: 0 +Accept pipeline input: False +``` + +### -Scope +Scope of the SharePoint Framework client side extension application customizer, either Web, Site or All to return both (all is the default) + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: CustomActionScope +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -ThrowExceptionIfCustomActionNotFound +Switch parameter if an exception should be thrown if the requested SharePoint Frameworkclient side extension application customizer does not exist (true) or if omitted, nothing will be returned in case the SharePoint Framework client side extension application customizer does not exist + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Web +The web to apply the command to. Omit this parameter to use the current web. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: WebPipeBind +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuditing.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuditing.md index 577f8d3618..df815cbd01 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuditing.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuditing.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Get the Auditing setting of a site -## SYNTAX +## SYNTAX ```powershell Get-PnPAuditing [-Connection ] @@ -45,4 +45,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuthenticationRealm.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuthenticationRealm.md index 762e53fd9d..4afe2efdd5 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuthenticationRealm.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAuthenticationRealm.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the authentication realm -## SYNTAX +## SYNTAX ```powershell Get-PnPAuthenticationRealm [-Url ] @@ -68,4 +68,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAvailableClientSideComponents.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAvailableClientSideComponents.md index 02cfe6c81e..dd45a218cf 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAvailableClientSideComponents.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAvailableClientSideComponents.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Gets the available client side components on a particular page -## SYNTAX +## SYNTAX ```powershell Get-PnPAvailableClientSideComponents -Page @@ -102,4 +102,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAzureCertificate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAzureCertificate.md index 318014e0c7..56849d0ae2 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAzureCertificate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPAzureCertificate.md @@ -18,7 +18,7 @@ Certificate contains the PEM encoded certificate. PrivateKey contains the PEM encoded private key of the certificate. -## SYNTAX +## SYNTAX ```powershell Get-PnPAzureCertificate -CertificatePath @@ -76,4 +76,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSideComponent.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSideComponent.md index 4cdcabef94..af7074f7f2 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSideComponent.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSideComponent.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieve one or more Client-Side components from a page -## SYNTAX +## SYNTAX ```powershell Get-PnPClientSideComponent -Page @@ -95,4 +95,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSidePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSidePage.md index 84f8410260..aa817d7ab1 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSidePage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPClientSidePage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Gets a Client-Side Page -## SYNTAX +## SYNTAX ```powershell Get-PnPClientSidePage -Identity @@ -41,6 +41,13 @@ Get-PnPClientSidePage "Templates/MyPageTemplate" Gets the Modern Page (Client-Side) named 'MyPageTemplate.aspx' from the templates folder of the Page Library in the current SharePoint site +### ------------------EXAMPLE 4------------------ +```powershell +Get-PnPClientSidePage -Identity "MyPage.aspx" -Web (Get-PnPWeb -Identity "Subsite1") +``` + +Gets the Modern Page (Client-Side) named 'MyPage.aspx' from the subsite named 'Subsite1' + ## PARAMETERS ### -Identity @@ -87,4 +94,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPConnection.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPConnection.md index 20be7fdc5d..130e1b5227 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPConnection.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPConnection.md @@ -24,4 +24,4 @@ This will put the current connection for use with the -Connection parameter on o ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentType.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentType.md index c87adcfe1c..28614ca4a5 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentType.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentType.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieves a content type -## SYNTAX +## SYNTAX ```powershell Get-PnPContentType [-Identity ] @@ -24,7 +24,7 @@ Get-PnPContentType [-Identity ] ### ------------------EXAMPLE 1------------------ ```powershell -Get-PnPContentType +Get-PnPContentType ``` This will get a listing of all available content types within the current web @@ -118,4 +118,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentTypePublishingHubUrl.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentTypePublishingHubUrl.md index 02269ee9b6..88bfb57f08 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentTypePublishingHubUrl.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContentTypePublishingHubUrl.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the url to Content Type Publishing Hub -## SYNTAX +## SYNTAX ```powershell Get-PnPContentTypePublishingHubUrl [-Connection ] @@ -44,4 +44,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContext.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContext.md index a478e1a524..7f09f8c7d7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContext.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPContext.md @@ -22,10 +22,23 @@ $ctx = Get-PnPContext This will put the current context in the $ctx variable. +### ------------------EXAMPLE 2------------------ +```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 +``` + + + ## OUTPUTS ### Microsoft.SharePoint.Client.ClientContext ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPCustomAction.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPCustomAction.md index d0cd000590..af49cb6c38 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPCustomAction.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPCustomAction.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Return user custom actions -## SYNTAX +## SYNTAX +### ```powershell Get-PnPCustomAction [-Includes ] [-Identity ] @@ -127,4 +128,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDefaultColumnValues.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDefaultColumnValues.md index 8b8eabb41e..4f6a638760 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDefaultColumnValues.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDefaultColumnValues.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Gets the default column values for all folders in document library -## SYNTAX +## SYNTAX ```powershell Get-PnPDefaultColumnValues -List @@ -61,4 +61,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDeletedUnifiedGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDeletedUnifiedGroup.md new file mode 100644 index 0000000000..d611752e10 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDeletedUnifiedGroup.md @@ -0,0 +1,51 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/get-pnpdeletedunifiedgroup +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Get-PnPDeletedUnifiedGroup + +## SYNOPSIS +Gets one deleted Office 365 Group (aka Unified Group) or a list of deleted Office 365 Groups + +## SYNTAX + +```powershell +Get-PnPDeletedUnifiedGroup [-Identity ] +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Get-PnPDeletedUnifiedGroup +``` + +Retrieves all deleted Office 365 Groups + +### ------------------EXAMPLE 2------------------ +```powershell +Get-PnPDeletedUnifiedGroup -Identity 38b32e13-e900-4d95-b860-fb52bc07ca7f +``` + +Retrieves a specific deleted Office 365 Group based on its ID + +## PARAMETERS + +### -Identity +The Identity of the Office 365 Group. + +```yaml +Type: UnifiedGroupPipeBind +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDocumentSetTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDocumentSetTemplate.md index 1bc67e49df..accb0ddebb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDocumentSetTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPDocumentSetTemplate.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Retrieves a document set template -## SYNTAX +## SYNTAX +### ```powershell Get-PnPDocumentSetTemplate -Identity [-Includes ] @@ -91,4 +92,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPEventReceiver.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPEventReceiver.md index 06b4c87ca6..3a99081f1a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPEventReceiver.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPEventReceiver.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Return registered eventreceivers -## SYNTAX +## SYNTAX ### List ```powershell @@ -143,4 +143,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPException.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPException.md index 88ee66d943..3ffa18c155 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPException.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPException.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the last exception that occurred -## SYNTAX +## SYNTAX ```powershell Get-PnPException [-All []] @@ -51,4 +51,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFeature.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFeature.md index 3fe8ee86be..1ad782b29c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFeature.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFeature.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Returns all activated or a specific activated feature -## SYNTAX +## SYNTAX +### ```powershell Get-PnPFeature [-Includes ] [-Identity ] @@ -118,4 +119,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPField.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPField.md index 2604d72156..1a4793f3a3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPField.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPField.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Returns a field from a list or site -## SYNTAX +## SYNTAX +### ```powershell Get-PnPField [-Includes ] [-List ] @@ -130,4 +131,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFile.md index 5ba781c400..da2cdb4842 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFile.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFile.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Downloads a file. -## SYNTAX +## SYNTAX ### Return as file object ```powershell @@ -220,4 +220,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolder.md index 5e9369501e..2645fdfcdb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolder.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolder.md @@ -10,17 +10,31 @@ schema: 2.0.0 ## SYNOPSIS Return a folder object -## SYNTAX +## SYNTAX +### +```powershell +Get-PnPFolder [-Includes ] + [-Web ] + [-Connection ] +``` + +### Folder By Url ```powershell Get-PnPFolder -Url - [-Includes ] + [-Web ] + [-Connection ] +``` + +### Folders In List +```powershell +Get-PnPFolder -List [-Web ] [-Connection ] ``` ## DESCRIPTION -Retrieves a folder if it exists. Use Ensure-PnPFolder to create the folder if it does not exist. +Retrieves a folder if it exists or all folders inside a provided list or library. Use Ensure-PnPFolder to create the folder if it does not exist. ## EXAMPLES @@ -38,6 +52,13 @@ Get-PnPFolder -Url "/sites/demo/Shared Documents" Returns the folder called 'Shared Documents' which is located in the root of the current web +### ------------------EXAMPLE 3------------------ +```powershell +Get-PnPFolder -List "Shared Documents" +``` + +Returns the folder(s) residing inside a folder called 'Shared Documents' + ## PARAMETERS ### -Includes @@ -52,12 +73,24 @@ Position: 0 Accept pipeline input: False ``` +### -List +Name, ID or instance of a list or document library to retrieve the folders residing in it for. + +```yaml +Type: ListPipeBind +Parameter Sets: Folders In List + +Required: True +Position: 1 +Accept pipeline input: False +``` + ### -Url 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. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Folder By Url Aliases: RelativeUrl Required: True @@ -95,4 +128,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Ensure-PnPFolder](https://github.com/OfficeDev/PnP-PowerShell/blob/master/Documentation/EnsureSPOFolder.md) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Ensure-PnPFolder](https://github.com/OfficeDev/PnP-PowerShell/blob/master/Documentation/EnsureSPOFolder.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolderItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolderItem.md index d009183708..79c102605e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolderItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPFolderItem.md @@ -10,12 +10,24 @@ schema: 2.0.0 ## SYNOPSIS List content in folder -## SYNTAX +## SYNTAX +### Folder via url ```powershell Get-PnPFolderItem [-FolderSiteRelativeUrl ] [-ItemType ] [-ItemName ] + [-Recursive []] + [-Web ] + [-Connection ] +``` + +### Folder via pipebind +```powershell +Get-PnPFolderItem [-Identity ] + [-ItemType ] + [-ItemName ] + [-Recursive []] [-Web ] [-Connection ] ``` @@ -50,20 +62,39 @@ Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -ItemType File Returns all files in the folder SitePages which is located in the root of the current web +### ------------------EXAMPLE 5------------------ +```powershell +Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -Recursive +``` + +Returns all files and folders, including contents of any subfolders, in the folder SitePages which is located in the root of the current web + ## PARAMETERS ### -FolderSiteRelativeUrl -The site relative folder to retrieve +The site relative URL of the folder to retrieve ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Folder via url Required: False Position: 0 Accept pipeline input: True ``` +### -Identity +A folder instance to the folder to retrieve + +```yaml +Type: FolderPipeBind +Parameter Sets: Folder via pipebind + +Required: False +Position: 0 +Accept pipeline input: False +``` + ### -ItemName Optional name of the item to retrieve @@ -88,6 +119,18 @@ Position: Named Accept pipeline input: False ``` +### -Recursive +A switch parameter to include contents of all subfolders in the specified folder + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: 4 +Accept pipeline input: False +``` + ### -Connection Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. @@ -114,4 +157,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroup.md index d40caafd4f..9460b004aa 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroup.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroup.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns a specific SharePoint group or all SharePoint groups in site. -## SYNTAX +## SYNTAX ### ByName ```powershell @@ -163,4 +163,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupMembers.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupMembers.md index a9457ef1c6..d4f5decf66 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupMembers.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupMembers.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieves all members of a group -## SYNTAX +## SYNTAX ```powershell Get-PnPGroupMembers -Identity @@ -88,4 +88,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupPermissions.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupPermissions.md index 6cc44b706f..2484b0e645 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupPermissions.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPGroupPermissions.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the permissions for a specific SharePoint group -## SYNTAX +## SYNTAX ### ByName ```powershell @@ -73,4 +73,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHealthScore.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHealthScore.md index 1570db8f14..ff37123aa8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHealthScore.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHealthScore.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-PnPHealthScore ## SYNOPSIS -Retrieves the healthscore value. +Retrieves the healthscore of the site given in his Url parameter or from the current connection if the Url parameter is not provided ## DESCRIPTION Retrieves the current X-SharePointHealthScore value of the server, or CPU, on which your SharePoint instance runs. X-SharePointHealthScore is a value between 0 and 10, where 0 indicates the server is idle and 10 indicates the server is very busy. For more information visit https://docs.microsoft.com/office365/enterprise/diagnosing-performance-issues-with-sharepoint-online and https://docs.microsoft.com/openspecs/sharepoint_protocols/ms-wsshp/c60ddeb6-4113-4a73-9e97-26b5c3907d33. @@ -37,4 +37,4 @@ Returns a int value representing the current health score value of the server. ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHideDefaultThemes.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHideDefaultThemes.md index 81b9709b6c..26bbf18b31 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHideDefaultThemes.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHideDefaultThemes.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns if the default / OOTB themes should be visible to users or not. -## SYNTAX +## SYNTAX ```powershell Get-PnPHideDefaultThemes [-Connection ] @@ -46,4 +46,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHomePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHomePage.md index 3d9b882fd4..28c2761d78 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHomePage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHomePage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Return the homepage -## SYNTAX +## SYNTAX ```powershell Get-PnPHomePage [-Web ] @@ -61,4 +61,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHomeSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHomeSite.md index 39bce43899..9bc43071db 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHomeSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHomeSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the home site url for your tenant -## SYNTAX +## SYNTAX ```powershell Get-PnPHomeSite [-Connection ] @@ -41,4 +41,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHubSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHubSite.md index 6750a0aa3d..f87fed2287 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHubSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHubSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieve all or a specific hubsite. -## SYNTAX +## SYNTAX ```powershell Get-PnPHubSite [-Connection ] @@ -48,4 +48,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHubSiteChild.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHubSiteChild.md new file mode 100644 index 0000000000..15f67b3479 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPHubSiteChild.md @@ -0,0 +1,47 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/get-pnphubsitechild +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Get-PnPHubSiteChild + +## SYNOPSIS +Retrieves all sites linked to a specific hub site + +## SYNTAX + +```powershell +Get-PnPHubSiteChild [-Connection ] +``` + +## DESCRIPTION +Retrieves all sites linked to a specific hub site + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Get-PnPHubChildSite -Identity https://contoso.sharepoint.com/sites/myhubsite +``` + +Returns the sites having configured the provided hub site as their hub site + +## PARAMETERS + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPInPlaceRecordsManagement.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPInPlaceRecordsManagement.md index 3762563b2d..f6979bba42 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPInPlaceRecordsManagement.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPInPlaceRecordsManagement.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns if the place records management feature is enabled. -## SYNTAX +## SYNTAX ```powershell Get-PnPInPlaceRecordsManagement [-Web ] @@ -54,4 +54,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPIndexedPropertyKeys.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPIndexedPropertyKeys.md index 4ae68d19a8..286a2f172c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPIndexedPropertyKeys.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPIndexedPropertyKeys.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the keys of the property bag values that have been marked for indexing by search -## SYNTAX +## SYNTAX ```powershell Get-PnPIndexedPropertyKeys [-List ] @@ -58,4 +58,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPJavaScriptLink.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPJavaScriptLink.md index 4841440919..2c7ebfc240 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPJavaScriptLink.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPJavaScriptLink.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns all or a specific custom action(s) with location type ScriptLink -## SYNTAX +## SYNTAX ```powershell Get-PnPJavaScriptLink [-Name ] @@ -126,4 +126,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPLabel.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPLabel.md index 1030d07daa..ce931c54ad 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPLabel.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPLabel.md @@ -8,9 +8,9 @@ schema: 2.0.0 # Get-PnPLabel ## SYNOPSIS -Gets the label/tag of the specified list or library (if applicable) +Gets the Office 365 retention label/tag of the specified list or library (if applicable) -## SYNTAX +## SYNTAX ```powershell Get-PnPLabel -List @@ -25,7 +25,7 @@ Get-PnPLabel -List Get-PnPLabel -List "Demo List" ``` -This gets the label which is set to a list or a library. +This gets the Office 365 retention label which is set to a list or a library. ## PARAMETERS @@ -67,4 +67,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPList.md index 8c62c1c7df..169e1113c3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPList.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPList.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Returns a List object -## SYNTAX +## SYNTAX +### ```powershell Get-PnPList [-Includes ] [-Identity ] @@ -111,4 +112,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListInformationRightsManagement.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListInformationRightsManagement.md index 61a8c346f2..a4cb1fb3a4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListInformationRightsManagement.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListInformationRightsManagement.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Get the site closure status of the site which has a site policy applied -## SYNTAX +## SYNTAX ```powershell Get-PnPListInformationRightsManagement -List @@ -67,4 +67,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListItem.md index c87dccfbe7..4ac2cde3d4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListItem.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieves list items -## SYNTAX +## SYNTAX ### By Id ```powershell @@ -217,4 +217,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListRecordDeclaration.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListRecordDeclaration.md index 2ad49e7926..c97ba569c0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListRecordDeclaration.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPListRecordDeclaration.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the manual record declaration settings for a list -## SYNTAX +## SYNTAX ```powershell Get-PnPListRecordDeclaration -List @@ -67,4 +67,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPManagementApiAccessToken.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPManagementApiAccessToken.md new file mode 100644 index 0000000000..a1f5c6f83c --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPManagementApiAccessToken.md @@ -0,0 +1,77 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/get-pnpmanagementapiaccesstoken +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Get-PnPManagementApiAccessToken + +## SYNOPSIS +Gets an access token for the Office 365 Management API + +## SYNTAX + +```powershell +Get-PnPManagementApiAccessToken -TenantId + -ClientId + -ClientSecret +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Get-PnPManagementApiAccessToken -TenantId $tenantId -ClientId $clientId -ClientSecret $clientSecret) +``` + +Retrieves access token for the Office 365 Management API + +### ------------------EXAMPLE 2------------------ +```powershell +Connect-PnPOnline -AccessToken (Get-PnPManagementApiAccessToken -TenantId $tenantId -ClientId $clientId -ClientSecret $clientSecret) +``` + +Connects to the Office 365 Management API using an access token for the Office 365 Management API + +## PARAMETERS + +### -ClientId +The App\Client ID of the app which gives you access to the Office 365 Management API + +```yaml +Type: String +Parameter Sets: (All) + +Required: True +Position: Named +Accept pipeline input: False +``` + +### -ClientSecret +The Client Secret of the app which gives you access to the Office 365 Management API + +```yaml +Type: String +Parameter Sets: (All) + +Required: True +Position: Named +Accept pipeline input: False +``` + +### -TenantId +The Tenant ID to connect to the Office 365 Management API + +```yaml +Type: String +Parameter Sets: (All) + +Required: True +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPMasterPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPMasterPage.md index 43d73edd16..ec65f4449c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPMasterPage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPMasterPage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the URLs of the default Master Page and the custom Master Page. -## SYNTAX +## SYNTAX ```powershell Get-PnPMasterPage [-Web ] @@ -45,4 +45,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPNavigationNode.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPNavigationNode.md index 7a0584763f..ff829cac72 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPNavigationNode.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPNavigationNode.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns all or a specific navigation node -## SYNTAX +## SYNTAX ### All nodes by location ```powershell @@ -123,4 +123,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPOrgAssetsLibrary.md new file mode 100644 index 0000000000..f872e92378 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPOrgAssetsLibrary.md @@ -0,0 +1,51 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/get-pnporgassetslibrary +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Get-PnPOrgAssetsLibrary + +## SYNOPSIS +Returns the list of all the configured organizational asset libraries + +## SYNTAX + +```powershell +Get-PnPOrgAssetsLibrary [-Connection ] +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Get-PnPOrgAssetsLibrary +``` + +Returns the list of all the configured organizational asset sites + +### ------------------EXAMPLE 2------------------ +```powershell +(Get-PnPOrgAssetsLibrary)[0].OrgAssetsLibraries[0].LibraryUrl.DecodedUrl +``` + +Returns the server relative url of the first document library which has been flagged as organizational asset library, i.e. "sites/branding/logos" + +## PARAMETERS + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPOrgNewsSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPOrgNewsSite.md new file mode 100644 index 0000000000..67a1f9a070 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPOrgNewsSite.md @@ -0,0 +1,44 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/get-pnporgnewssite +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Get-PnPOrgNewsSite + +## SYNOPSIS +Returns the list of all the configured organizational news sites. + +## SYNTAX + +```powershell +Get-PnPOrgNewsSite [-Connection ] +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Get-PnPOrgNewsSite +``` + +Returns the list of all the configured organizational news sites. + +## PARAMETERS + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPowerShellTelemetryEnabled.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPowerShellTelemetryEnabled.md index 33bf30c3d2..df65f64923 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPowerShellTelemetryEnabled.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPowerShellTelemetryEnabled.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns true if the PnP PowerShell Telemetry has been enabled. -## SYNTAX +## SYNTAX ```powershell Get-PnPPowerShellTelemetryEnabled [-Connection ] @@ -44,4 +44,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProperty.md index ca32d3b3ec..c259b86145 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProperty.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProperty.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns a previously not loaded property of a ClientObject -## SYNTAX +## SYNTAX ```powershell Get-PnPProperty -ClientObject @@ -86,4 +86,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPropertyBag.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPropertyBag.md index 04c65fa1b5..bc1795eaf5 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPropertyBag.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPropertyBag.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the property bag values. -## SYNTAX +## SYNTAX ```powershell Get-PnPPropertyBag [-Key ] @@ -112,4 +112,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplate.md index 25f63fad46..9545425aa2 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPProvisioningTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Generates a provisioning site template from a web -## SYNTAX +## SYNTAX ```powershell Get-PnPProvisioningTemplate [-Out ] @@ -40,6 +40,7 @@ Get-PnPProvisioningTemplate [-Out ] [-OutputInstance []] [-ExcludeContentTypesFromSyndication []] [-ListsToExtract ] + [-Configuration ] [-Schema ] [-Web ] [-Connection ] @@ -152,6 +153,18 @@ Extracts a provisioning template in Office Open XML from the current web, includ ## PARAMETERS +### -Configuration +Specify a JSON configuration file to configure the extraction progress. + +```yaml +Type: ExtractConfigurationPipeBind +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -ContentTypeGroups Allows you to specify from which content type group(s) the content types should be included into the template. @@ -518,4 +531,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Encoding](https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Encoding](https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPublishingImageRendition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPublishingImageRendition.md index f274fc3412..23479725a9 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPublishingImageRendition.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPPublishingImageRendition.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns all image renditions or if Identity is specified a specific one -## SYNTAX +## SYNTAX ```powershell Get-PnPPublishingImageRendition [-Identity ] @@ -85,4 +85,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRecycleBinItem.md index 7f1a4a8e85..ff701cf3a7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRecycleBinItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRecycleBinItem.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the items in the recycle bin from the context -## SYNTAX +## SYNTAX ### Identity ```powershell @@ -21,12 +21,20 @@ Get-PnPRecycleBinItem [-Identity ] ### FirstStage ```powershell Get-PnPRecycleBinItem [-FirstStage []] + [-RowLimit ] [-Connection ] ``` ### SecondStage ```powershell Get-PnPRecycleBinItem [-SecondStage []] + [-RowLimit ] + [-Connection ] +``` + +### All +```powershell +Get-PnPRecycleBinItem [-RowLimit ] [-Connection ] ``` @@ -66,6 +74,13 @@ Get-PnPRecycleBinItem -SecondStage Returns all items in only the second stage recycle bin in the current site collection +### ------------------EXAMPLE 5------------------ +```powershell +Get-PnPRecycleBinItem -RowLimit 10000 +``` + +Returns items in recycle bin limited by number of results + ## PARAMETERS ### -FirstStage @@ -104,6 +119,20 @@ Position: 0 Accept pipeline input: False ``` +### -RowLimit +Limits return results to specified amount + +Only applicable to: SharePoint Online, SharePoint Server 2019, SharePoint Server 2016 + +```yaml +Type: Int +Parameter Sets: FirstStage, SecondStage, All + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -SecondStage Return all items in the second stage recycle bin @@ -134,4 +163,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRequestAccessEmails.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRequestAccessEmails.md index b779fa45cc..2beb4dc928 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRequestAccessEmails.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRequestAccessEmails.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the request access e-mail addresses -## SYNTAX +## SYNTAX ```powershell Get-PnPRequestAccessEmails [-Web ] @@ -58,4 +58,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRoleDefinition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRoleDefinition.md index 36e8a094a1..8b7622f67a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRoleDefinition.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPRoleDefinition.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieves a Role Definitions of a site -## SYNTAX +## SYNTAX ```powershell Get-PnPRoleDefinition [-Identity ] @@ -65,4 +65,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchConfiguration.md index d491f2e183..d169cbb562 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchConfiguration.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchConfiguration.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the search configuration -## SYNTAX +## SYNTAX ### Xml ```powershell @@ -135,4 +135,4 @@ Does not return a string when the -Path parameter has been specified. ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchCrawlLog.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchCrawlLog.md index 953e12202e..6906285619 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchCrawlLog.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchCrawlLog.md @@ -8,9 +8,9 @@ schema: 2.0.0 # Get-PnPSearchCrawlLog ## SYNOPSIS -Returns entries from the SharePoint search crawl log +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://-admin.sharepoint.com/_layouts/15/searchadmin/crawllogreadpermission.aspx in order to run this cmdlet. -## SYNTAX +## SYNTAX ```powershell Get-PnPSearchCrawlLog [-LogLevel ] @@ -19,6 +19,7 @@ Get-PnPSearchCrawlLog [-LogLevel ] [-ContentSource ] [-StartDate ] [-EndDate ] + [-RawFormat []] [-Web ] [-Connection ] ``` @@ -41,7 +42,7 @@ Returns the last 100 crawl log entries for OneDrive content. ### ------------------EXAMPLE 3------------------ ```powershell -Get-PnPSearchCrawlLog -ContentSource UserProfiles +Get-PnPSearchCrawlLog -ContentSource UserProfiles ``` Returns the last 100 crawl log entries for user profiles. @@ -55,7 +56,7 @@ Returns the last 100 crawl log entries for user profiles with the term "mikael" ### ------------------EXAMPLE 5------------------ ```powershell -Get-PnPSearchCrawlLog -ContentSource Sites LogLevel Error -RowLimit 10 +Get-PnPSearchCrawlLog -ContentSource Sites -LogLevel Error -RowLimit 10 ``` Returns the last 10 crawl log entries with a state of Error for site content. @@ -65,7 +66,14 @@ Returns the last 10 crawl log entries with a state of Error for site content. Get-PnPSearchCrawlLog -EndDate (Get-Date).AddDays(-100) ``` -Returns the last 100 crawl log entries for site content up until 100 days ago. +Returns the last 100 crawl log entries up until 100 days ago. + +### ------------------EXAMPLE 7------------------ +```powershell +Get-PnPSearchCrawlLog -RowFilter 3 -RawFormat +``` + +Returns the last 3 crawl log entries showing the raw crawl log data. ## PARAMETERS @@ -117,6 +125,18 @@ Position: Named Accept pipeline input: False ``` +### -RawFormat +Show raw crawl log data + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -RowLimit Number of entries to return. Defaults to 100. @@ -167,4 +187,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchSettings.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchSettings.md new file mode 100644 index 0000000000..2f34a92d33 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSearchSettings.md @@ -0,0 +1,57 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/get-pnpsearchsettings +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Get-PnPSearchSettings + +## SYNOPSIS +Retrieves search settings for a site + +## SYNTAX + +```powershell +Get-PnPSearchSettings [-Web ] + [-Connection ] +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Get-PnPSearchSettings +``` + +Retrieve search settings for the site + +## PARAMETERS + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Web +This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. + +```yaml +Type: WebPipeBind +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSite.md index b772bef716..b6bb138a16 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSite.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Returns the current site collection from the context. -## SYNTAX +## SYNTAX +### ```powershell Get-PnPSite [-Includes ] [-Connection ] @@ -65,4 +66,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClassification.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClassification.md index ffe4deb649..bbd5d046b4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClassification.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClassification.md @@ -22,4 +22,4 @@ Returns the currently set site classifications for the tenant. ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClosure.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClosure.md index c908c0d01b..0ca219678b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClosure.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteClosure.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Get the site closure status of the site which has a site policy applied -## SYNTAX +## SYNTAX ```powershell Get-PnPSiteClosure [-Web ] @@ -54,4 +54,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionAdmin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionAdmin.md index 764c2eafcb..a4fac2d67b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionAdmin.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionAdmin.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the current site collection administrators of the site collection in the current context -## SYNTAX +## SYNTAX ```powershell Get-PnPSiteCollectionAdmin [-Web ] @@ -57,4 +57,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionTermStore.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionTermStore.md index fdc5c5b2dc..fa549ec921 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionTermStore.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteCollectionTermStore.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the site collection term store -## SYNTAX +## SYNTAX ```powershell Get-PnPSiteCollectionTermStore [-Connection ] @@ -45,4 +45,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesign.md index f1d75bd932..d13c552752 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesign.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesign.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieve Site Designs that have been registered on the current tenant. -## SYNTAX +## SYNTAX ```powershell Get-PnPSiteDesign [-Identity ] @@ -61,4 +61,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRights.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRights.md index 801a432758..fff4ca5571 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRights.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRights.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the principals with design rights on a specific Site Design -## SYNTAX +## SYNTAX ```powershell Get-PnPSiteDesignRights -Identity @@ -54,4 +54,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRun.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRun.md index d79236275a..14697a0059 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRun.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRun.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS 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. -## SYNTAX +## SYNTAX ```powershell Get-PnPSiteDesignRun [-SiteDesignId ] @@ -87,4 +87,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRunStatus.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRunStatus.md index bc3183419d..f98bfa901a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRunStatus.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignRunStatus.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieves and displays a list of all site script actions executed for a specified site design applied to a site. -## SYNTAX +## SYNTAX ```powershell Get-PnPSiteDesignRunStatus -Run @@ -25,7 +25,7 @@ $myrun = Get-PnPSiteDesignRun -WebUrl "https://contoso.sharepoint.com/sites/proj Get-PnPSiteDesignRunStatus -Run $myrun ``` -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. +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. ## PARAMETERS @@ -55,4 +55,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignTask.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignTask.md index 676c1c1cfd..d3ae7b550d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignTask.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteDesignTask.md @@ -8,9 +8,9 @@ schema: 2.0.0 # Get-PnPSiteDesignTask ## SYNOPSIS -Used to retrieve a scheduled site design script. It takes the ID of the scheduled site design and the URL for the site where the site design is scheduled to be applied. +Used to retrieve a scheduled site design script. It takes the ID of the scheduled site design and the URL for the site where the site design is scheduled to be applied. -## SYNTAX +## SYNTAX ```powershell Get-PnPSiteDesignTask [-Identity ] @@ -94,4 +94,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSitePolicy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSitePolicy.md index 6e164245dc..3c2c9a710f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSitePolicy.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSitePolicy.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieves all or a specific site policy -## SYNTAX +## SYNTAX ```powershell Get-PnPSitePolicy [-AllAvailable []] @@ -98,4 +98,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteScript.md index b6b28009ff..3ed7fe5211 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteScript.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteScript.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieve Site Scripts that have been registered on the current tenant. -## SYNTAX +## SYNTAX ```powershell Get-PnPSiteScript [-Identity ] @@ -74,4 +74,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteSearchQueryResults.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteSearchQueryResults.md index 93646c26a3..728d434ecb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteSearchQueryResults.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSiteSearchQueryResults.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Executes a search query to retrieve indexed site collections -## SYNTAX +## SYNTAX ### Limit ```powershell @@ -153,4 +153,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStorageEntity.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStorageEntity.md index f7a30e6e20..716c3cb270 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStorageEntity.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStorageEntity.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieve Storage Entities / Farm Properties from either the Tenant App Catalog or from the current site if it has a site scope app catalog. -## SYNTAX +## SYNTAX ```powershell Get-PnPStorageEntity [-Key ] @@ -88,4 +88,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStoredCredential.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStoredCredential.md index 5c95e1c195..a5a7a9fca6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStoredCredential.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPStoredCredential.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Get a credential -## SYNTAX +## SYNTAX ```powershell Get-PnPStoredCredential -Name @@ -64,4 +64,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSubWebs.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSubWebs.md index 5d469ad8e4..39ee73e191 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSubWebs.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPSubWebs.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Returns the subwebs of the current web -## SYNTAX +## SYNTAX +### ```powershell Get-PnPSubWebs [-Includes ] [-Identity ] @@ -118,4 +119,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomyItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomyItem.md index e77a018d58..7aac6f8efb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomyItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomyItem.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns a taxonomy item -## SYNTAX +## SYNTAX ```powershell Get-PnPTaxonomyItem -TermPath @@ -50,4 +50,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomySession.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomySession.md index eac739881a..8c72efc306 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomySession.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTaxonomySession.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns a taxonomy session -## SYNTAX +## SYNTAX ```powershell Get-PnPTaxonomySession [-Web ] @@ -49,4 +49,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenant.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenant.md index 40537a58d1..2b01d4fd4b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenant.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenant.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns organization-level site collection properties -## SYNTAX +## SYNTAX ```powershell Get-PnPTenant [-Connection ] @@ -49,4 +49,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantAppCatalogUrl.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantAppCatalogUrl.md index 274873e1d6..5ff8e6140e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantAppCatalogUrl.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantAppCatalogUrl.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieves the url of the tenant scoped app catalog. -## SYNTAX +## SYNTAX ```powershell Get-PnPTenantAppCatalogUrl [-Connection ] @@ -41,4 +41,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnEnabled.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnEnabled.md index 7f7d014e2b..9109ddc437 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnEnabled.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnEnabled.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieves if the Office 365 Content Delivery Network has been enabled. -## SYNTAX +## SYNTAX ```powershell Get-PnPTenantCdnEnabled -CdnType @@ -57,4 +57,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnOrigin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnOrigin.md index eaeef02ec3..00adc4f6ec 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnOrigin.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnOrigin.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the current registered origins from the public or private content delivery network (CDN). -## SYNTAX +## SYNTAX ```powershell Get-PnPTenantCdnOrigin -CdnType @@ -57,4 +57,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnPolicies.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnPolicies.md index 1a8577908a..0e6f3135ee 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnPolicies.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantCdnPolicies.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the CDN Policies for the specified CDN (Public | Private). -## SYNTAX +## SYNTAX ```powershell Get-PnPTenantCdnPolicies -CdnType @@ -57,4 +57,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantId.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantId.md new file mode 100644 index 0000000000..173b73f802 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantId.md @@ -0,0 +1,51 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/get-pnptenantid +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Get-PnPTenantId + +## SYNOPSIS +Returns the Tenant ID + +## SYNTAX + +```powershell +Get-PnPTenantId [-TenantUrl ] +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Get-PnPTenantId +``` + +Returns the current Tenant Id. A valid connection with Connect-PnPOnline is required. + +### ------------------EXAMPLE 2------------------ +```powershell +Get-PnPTenantId -TenantUrl https://contoso.sharepoint.com +``` + +Returns the Tenant ID for the specified tenant. Can be executed without a connecting first with Connect-PnPOnline + +## PARAMETERS + +### -TenantUrl + + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantRecycleBinItem.md index d60318d6f7..85f2eb52b6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantRecycleBinItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantRecycleBinItem.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns all modern and classic site collections in the tenant scoped recycle bin -## SYNTAX +## SYNTAX ```powershell Get-PnPTenantRecycleBinItem [-Connection ] @@ -48,4 +48,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequence.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequence.md index 58ff2cdac9..01433ecd16 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequence.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequence.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns one ore more provisioning sequence object(s) from a tenant template -## SYNTAX +## SYNTAX ```powershell Get-PnPTenantSequence -Template @@ -21,14 +21,14 @@ Get-PnPTenantSequence -Template ### ------------------EXAMPLE 1------------------ ```powershell -Get-PnPTenantSequence -Template $myhierarchy +Get-PnPTenantSequence -Template $myTemplateObject ``` Returns all sequences from the specified tenant template ### ------------------EXAMPLE 2------------------ ```powershell -Get-PnPTenantSequence -Template $myhierarchy -Identity "mysequence" +Get-PnPTenantSequence -Template $myTemplateObject -Identity "mysequence" ``` Returns the specified sequence from the specified tenant template @@ -50,7 +50,7 @@ Accept pipeline input: True ``` ### -Template -The hierarchy to retrieve the sequence from +The template to retrieve the sequence from Only applicable to: SharePoint Online @@ -65,4 +65,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequenceSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequenceSite.md index 474acb6da1..4be455360a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequenceSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSequenceSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns one ore more sites from a tenant template -## SYNTAX +## SYNTAX ```powershell Get-PnPTenantSequenceSite -Sequence @@ -65,4 +65,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipal.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipal.md index dc4af75ff3..c5447b11df 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipal.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipal.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the current tenant's "SharePoint Online Client" service principal. -## SYNTAX +## SYNTAX ```powershell Get-PnPTenantServicePrincipal [-Connection ] @@ -35,4 +35,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionGrants.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionGrants.md index e2b02fb5e2..a8adaa01b7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionGrants.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionGrants.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Gets the collection of permission grants for the "SharePoint Online Client" service principal -## SYNTAX +## SYNTAX ```powershell Get-PnPTenantServicePrincipalPermissionGrants [-Connection ] @@ -45,4 +45,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionRequests.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionRequests.md index 4b591363fc..f2fe2b3574 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionRequests.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantServicePrincipalPermissionRequests.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Gets the collection of permission requests for the "SharePoint Online Client" service principal -## SYNTAX +## SYNTAX ```powershell Get-PnPTenantServicePrincipalPermissionRequests [-Connection ] @@ -44,4 +44,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSite.md index ddeda87ef5..24a67eb6e0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Retrieve site information. -## SYNTAX +## SYNTAX ```powershell Get-PnPTenantSite [-Url ] @@ -70,7 +70,7 @@ Returns all Communication sites ### ------------------EXAMPLE 7------------------ ```powershell -Get-PnPTenantSite -Filter "Url -like 'sales'" +Get-PnPTenantSite -Filter "Url -like 'sales'" ``` Returns all sites including 'sales' in the url @@ -156,4 +156,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantTemplate.md new file mode 100644 index 0000000000..c52a2dad5a --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantTemplate.md @@ -0,0 +1,129 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/get-pnptenanttemplate +applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +schema: 2.0.0 +--- + +# Get-PnPTenantTemplate + +## SYNOPSIS +Generates a provisioning tenant template from a site. If the site is a hubsite any connected site will be included. + +## SYNTAX + +### Extract a template to a file +```powershell +Get-PnPTenantTemplate -Out + [-SiteUrl ] + [-Force []] + [-Configuration ] + [-Connection ] +``` + +### Extract a template as an object +```powershell +Get-PnPTenantTemplate -AsInstance [] + [-SiteUrl ] + [-Configuration ] + [-Connection ] +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Get-PnPTenantTemplate -Out tenanttemplate.xml +``` + +Extracts a tenant template + +## PARAMETERS + +### -AsInstance +Returns the template as an in-memory object, which is an instance of the ProvisioningHierarchy type of the PnP Core Component. It cannot be used together with the -Out parameter. + +Only applicable to: SharePoint Online + +```yaml +Type: SwitchParameter +Parameter Sets: Extract a template as an object + +Required: True +Position: Named +Accept pipeline input: False +``` + +### -Configuration +Specify a JSON configuration file to configure the extraction progress. + +Only applicable to: SharePoint Online + +```yaml +Type: ExtractConfigurationPipeBind +Parameter Sets: Extract a template to a file, Extract a template as an object + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Force +Overwrites the output file if it exists. + +Only applicable to: SharePoint Online + +```yaml +Type: SwitchParameter +Parameter Sets: Extract a template to a file + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Out +Filename to write to, optionally including full path + +Only applicable to: SharePoint Online + +```yaml +Type: String +Parameter Sets: Extract a template to a file + +Required: True +Position: 0 +Accept pipeline input: False +``` + +### -SiteUrl + + +Only applicable to: SharePoint Online + +```yaml +Type: String +Parameter Sets: Extract a template to a file, Extract a template as an object + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +Only applicable to: SharePoint Online + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantTheme.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantTheme.md index 71b18fea2c..a61ebb9989 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantTheme.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTenantTheme.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns all or a specific theme -## SYNTAX +## SYNTAX ```powershell Get-PnPTenantTheme [-Name ] @@ -64,4 +64,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTerm.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTerm.md index 22ac9d58b1..ee1e0c1ed1 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTerm.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTerm.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns a taxonomy term -## SYNTAX +## SYNTAX ### ```powershell @@ -172,4 +172,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermGroup.md index 0d53954cd3..c85ae0898f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermGroup.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermGroup.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Returns a taxonomy term group -## SYNTAX +## SYNTAX +### ```powershell Get-PnPTermGroup [-Includes ] [-Identity ] @@ -100,4 +101,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermSet.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermSet.md index 2c37c35ebe..02cb2af36d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermSet.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTermSet.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Returns a taxonomy term set -## SYNTAX +## SYNTAX +### ```powershell Get-PnPTermSet -TermGroup [-Includes ] @@ -111,4 +112,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTheme.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTheme.md index ca9ea63395..c57c128300 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTheme.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTheme.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the current theme/composed look of the current web. -## SYNTAX +## SYNTAX ```powershell Get-PnPTheme [-DetectCurrentComposedLook []] @@ -78,4 +78,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTimeZoneId.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTimeZoneId.md index f7bdddc59d..a0ee0a9f89 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTimeZoneId.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPTimeZoneId.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns a time zone ID -## SYNTAX +## SYNTAX ```powershell Get-PnPTimeZoneId [-Match ] @@ -57,4 +57,4 @@ Returns a list of matching zones. Use the ID property of the object for use in N ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUPABulkImportStatus.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUPABulkImportStatus.md index fd6a3c4f0e..63ae4f6acb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUPABulkImportStatus.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUPABulkImportStatus.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Get user profile bulk import status. -## SYNTAX +## SYNTAX ```powershell Get-PnPUPABulkImportStatus [-JobId ] @@ -91,4 +91,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedAuditLog.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedAuditLog.md new file mode 100644 index 0000000000..b57ffce650 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedAuditLog.md @@ -0,0 +1,71 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/get-pnpunifiedauditlog +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Get-PnPUnifiedAuditLog + +## SYNOPSIS +Gets unified audit logs from the Office 365 Management API. Requires the Azure Active Directory application permission 'ActivityFeed.Read'. + +## SYNTAX + +### Logs by date +```powershell +Get-PnPUnifiedAuditLog [-ContentType ] + [-StartTime ] + [-EndTime ] +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Get-PnPUnifiedAuditLog -ContentType SharePoint -StartTime (Get-Date).AddDays(-1) -EndTime (Get-Date).AddDays(-2) +``` + +Retrieves the audit logs of SharePoint happening between the current time yesterday and the current time the day before yesterday + +## PARAMETERS + +### -ContentType +Content type of logs to be retrieved, should be one of the following: AzureActiveDirectory, Exchange, SharePoint, General, DLP. + +```yaml +Type: AuditContentType +Parameter Sets: Logs by date + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -EndTime +End time of logs to be retrieved. Start time and end time must both be specified (or both omitted) and must be less than or equal to 24 hours apart. + +```yaml +Type: DateTime +Parameter Sets: Logs by date + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -StartTime +Start time of logs to be retrieved. Start time and end time must both be specified (or both omitted) and must be less than or equal to 24 hours apart, with the start time prior to end time and start time no more than 7 days in the past. + +```yaml +Type: DateTime +Parameter Sets: Logs by date + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroup.md index 7147984239..206fc9b49c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroup.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroup.md @@ -8,9 +8,9 @@ schema: 2.0.0 # Get-PnPUnifiedGroup ## SYNOPSIS -Gets one Office 365 Group (aka Unified Group) or a list of Office 365 Groups +Gets one Office 365 Group (aka Unified Group) or a list of Office 365 Groups. Requires the Azure Active Directory application permission 'Group.Read.All'. -## SYNTAX +## SYNTAX ```powershell Get-PnPUnifiedGroup [-Identity ] @@ -95,4 +95,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupMembers.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupMembers.md index 4cf45616cb..2fcdb27fdf 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupMembers.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupMembers.md @@ -8,9 +8,9 @@ schema: 2.0.0 # Get-PnPUnifiedGroupMembers ## SYNOPSIS -Gets members of a particular Office 365 Group (aka Unified Group) +Gets members of a particular Office 365 Group (aka Unified Group). Requires the Azure Active Directory application permissions 'Group.Read.All' and 'User.Read.All'. -## SYNTAX +## SYNTAX ```powershell Get-PnPUnifiedGroupMembers -Identity @@ -43,9 +43,9 @@ Parameter Sets: (All) Required: True Position: Named -Accept pipeline input: False +Accept pipeline input: True ``` ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupOwners.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupOwners.md index c53d056f92..39e4291b88 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupOwners.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUnifiedGroupOwners.md @@ -8,9 +8,9 @@ schema: 2.0.0 # Get-PnPUnifiedGroupOwners ## SYNOPSIS -Gets owners of a particular Office 365 Group (aka Unified Group) +Gets owners of a particular Office 365 Group (aka Unified Group). Requires the Azure Active Directory application permissions 'Group.Read.All' and 'User.Read.All'. -## SYNTAX +## SYNTAX ```powershell Get-PnPUnifiedGroupOwners -Identity @@ -43,9 +43,9 @@ Parameter Sets: (All) Required: True Position: Named -Accept pipeline input: False +Accept pipeline input: True ``` ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUser.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUser.md index 7d2b8408f5..0fdaf96e20 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUser.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUser.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns site users of current web -## SYNTAX +## SYNTAX ```powershell Get-PnPUser [-Identity ] @@ -20,7 +20,7 @@ Get-PnPUser [-Identity ] ``` ## DESCRIPTION -This command will return all the users that exist in the current site collection its User Information List +This command will return all users that exist in the current site collection's User Information List ## EXAMPLES @@ -40,7 +40,7 @@ Returns the user with Id 23 from the User Information List of the current site c ### ------------------EXAMPLE 3------------------ ```powershell -Get-PnPUser -Identity i:0#.f|membership|user@tenant.onmicrosoft.com +Get-PnPUser -Identity "i:0#.f|membership|user@tenant.onmicrosoft.com" ``` Returns the user with LoginName i:0#.f|membership|user@tenant.onmicrosoft.com from the User Information List of the current site collection @@ -122,4 +122,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUserProfileProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUserProfileProperty.md index ad30ecead7..d82e5b3c11 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUserProfileProperty.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPUserProfileProperty.md @@ -8,10 +8,10 @@ schema: 2.0.0 # Get-PnPUserProfileProperty ## SYNOPSIS -You must connect to the tenant admin website (https://:-admin.sharepoint.com) with Connect-PnPOnline in order to use this cmdlet. +You must connect to the tenant admin website (https://:-admin.sharepoint.com) with Connect-PnPOnline in order to use this cmdlet. -## SYNTAX +## SYNTAX ```powershell Get-PnPUserProfileProperty -Account @@ -69,4 +69,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPView.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPView.md index 897c8f98fd..6809ae29ff 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPView.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPView.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Returns one or all views from a list -## SYNTAX +## SYNTAX +### ```powershell Get-PnPView -List [-Includes ] @@ -111,4 +112,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWeb.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWeb.md index 3fe5442061..3c56d09bbe 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWeb.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWeb.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Returns the current web object -## SYNTAX +## SYNTAX +### ```powershell Get-PnPWeb [-Includes ] [-Identity ] @@ -71,4 +72,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPart.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPart.md index 5110a25d14..8c7c13d14c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPart.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPart.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns a web part definition object -## SYNTAX +## SYNTAX ```powershell Get-PnPWebPart -ServerRelativePageUrl @@ -92,4 +92,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartProperty.md index 9ae5c94b38..fdcd1aabbe 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartProperty.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartProperty.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns a web part property -## SYNTAX +## SYNTAX ```powershell Get-PnPWebPartProperty -ServerRelativePageUrl @@ -101,4 +101,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartXml.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartXml.md index c676e86d85..c478bad485 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartXml.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebPartXml.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the web part XML of a web part registered on a site -## SYNTAX +## SYNTAX ```powershell Get-PnPWebPartXml -ServerRelativePageUrl @@ -85,4 +85,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebTemplates.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebTemplates.md index 8ea5fbfbfb..bd19c8dce8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebTemplates.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebTemplates.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns the available web templates. -## SYNTAX +## SYNTAX ```powershell Get-PnPWebTemplates [-Lcid ] @@ -88,4 +88,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Locale IDs](https://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Locale IDs](http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebhookSubscriptions.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebhookSubscriptions.md index ba507aea6a..340ab79895 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebhookSubscriptions.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWebhookSubscriptions.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Gets all the Webhook subscriptions of the resource -## SYNTAX +## SYNTAX ```powershell Get-PnPWebhookSubscriptions [-List ] @@ -71,4 +71,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWikiPageContent.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWikiPageContent.md index eb23c67735..3311b59cb6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWikiPageContent.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWikiPageContent.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Gets the contents/source of a wiki page -## SYNTAX +## SYNTAX ```powershell Get-PnPWikiPageContent -ServerRelativePageUrl @@ -72,4 +72,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowDefinition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowDefinition.md index cfddf97f95..7c93a7c3dc 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowDefinition.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowDefinition.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns a workflow definition -## SYNTAX +## SYNTAX ```powershell Get-PnPWorkflowDefinition [-Name ] @@ -94,4 +94,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowInstance.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowInstance.md index a8736514b8..866f42b2a1 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowInstance.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowInstance.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Get workflow instances -## SYNTAX +## SYNTAX ```powershell Get-PnPWorkflowInstance -List @@ -90,4 +90,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowSubscription.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowSubscription.md index 8789b294bb..3d26dddd2a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowSubscription.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Get-PnPWorkflowSubscription.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Return a workflow subscription -## SYNTAX +## SYNTAX ```powershell Get-PnPWorkflowSubscription [-Name ] @@ -101,4 +101,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPHubSiteRights.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPHubSiteRights.md index ed31d585ee..8098aa0af8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPHubSiteRights.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPHubSiteRights.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Grant additional permissions to the permissions already in place to associate sites to Hub Sites for one or more specific users -## SYNTAX +## SYNTAX ```powershell Grant-PnPHubSiteRights [-Connection ] @@ -48,4 +48,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPSiteDesignRights.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPSiteDesignRights.md index de4793b566..0a0accc64a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPSiteDesignRights.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPSiteDesignRights.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Grants the specified principals rights to use the site design. -## SYNTAX +## SYNTAX ```powershell Grant-PnPSiteDesignRights -Identity @@ -87,4 +87,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPTenantServicePrincipalPermission.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPTenantServicePrincipalPermission.md index 7630396177..b214b61892 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPTenantServicePrincipalPermission.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Grant-PnPTenantServicePrincipalPermission.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Explicitly grants a specified permission to the "SharePoint Online Client" service principal -## SYNTAX +## SYNTAX ```powershell Grant-PnPTenantServicePrincipalPermission -Scope @@ -71,4 +71,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPAppPackage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPAppPackage.md index 6c5fd62279..c7e7eca84f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPAppPackage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPAppPackage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a SharePoint Addin to a site -## SYNTAX +## SYNTAX ```powershell Import-PnPAppPackage -Path @@ -32,7 +32,7 @@ Import-PnPAppPackage -Path c:\files\demo.app -LoadOnly ``` This will load the addin in the demo.app package, but will not install it to the site. - + ### ------------------EXAMPLE 2------------------ ```powershell @@ -40,7 +40,7 @@ Import-PnPAppPackage -Path c:\files\demo.app -Force ``` This load first activate the addin sideloading feature, upload and install the addin, and deactivate the addin sideloading feature. - + ## PARAMETERS @@ -122,4 +122,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTaxonomy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTaxonomy.md index 4ea309e552..491a54afca 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTaxonomy.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTaxonomy.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Imports a taxonomy from either a string array or a file -## SYNTAX +## SYNTAX ### Direct ```powershell @@ -143,4 +143,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermGroupFromXml.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermGroupFromXml.md index edb5511eef..c6d4197b9f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermGroupFromXml.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermGroupFromXml.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Imports a taxonomy TermGroup from either the input or from an XML file. -## SYNTAX +## SYNTAX ### XML ```powershell @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermSet.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermSet.md index 311f199575..8a0f709517 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermSet.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Import-PnPTermSet.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Imports a taxonomy term set from a file in the standard format. -## SYNTAX +## SYNTAX ```powershell Import-PnPTermSet -GroupName @@ -31,7 +31,7 @@ This is a CSV file, with the following headings: Term Set Name,Term Set Description,LCID,Available for Tagging,Term Description,Level 1 Term,Level 2 Term,Level 3 Term,Level 4 Term,Level 5 Term,Level 6 Term,Level 7 Term -The first data row must contain the Term Set Name, Term Set Description, and LCID, and should also contain the first term. +The first data row must contain the Term Set Name, Term Set Description, and LCID, and should also contain the first term. It is recommended that a fixed GUID be used as the termSetId, to allow the term set to be easily updated (so do not pass Guid.Empty). @@ -50,7 +50,7 @@ Creates (or updates) the term set specified in the import file, in the group spe ### ------------------EXAMPLE 2------------------ ```powershell -Import-PnPTermSet -TermStoreName 'My Term Store' -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -TermSetId '{15A98DB6-D8E2-43E6-8771-066C1EC2B8D8}' +Import-PnPTermSet -TermStoreName 'My Term Store' -GroupName 'Standard Terms' -Path 'C:\\Temp\\ImportTermSet.csv' -TermSetId '{15A98DB6-D8E2-43E6-8771-066C1EC2B8D8}' ``` Creates (or updates) the term set specified in the import file, in the term store and group specified, using the specified ID. @@ -174,4 +174,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPApp.md index 2377502749..85014d717c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPApp.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPApp.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Installs an available app from the app catalog -## SYNTAX +## SYNTAX ```powershell Install-PnPApp -Identity @@ -37,14 +37,14 @@ This will install an app that is available in the site collection scoped app cat ### ------------------EXAMPLE 3------------------ ```powershell -Get-PnPAvailableApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe | Install-PnPApp +Get-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe | Install-PnPApp ``` This will install the given app from the tenant scoped app catalog into the site. ### ------------------EXAMPLE 4------------------ ```powershell -Get-PnPAvailableApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site | Install-PnPApp +Get-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site | Install-PnPApp ``` This will install the given app from the site collection scoped app catalog into the site. @@ -109,4 +109,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPSolution.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPSolution.md index 3211a5479a..3beb1c8e42 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPSolution.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Install-PnPSolution.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Installs a sandboxed solution to a site collection. WARNING! This method can delete your composed look gallery due to the method used to activate the solution. We recommend you to only to use this cmdlet if you are okay with that. -## SYNTAX +## SYNTAX ```powershell Install-PnPSolution -PackageId @@ -93,4 +93,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPQuery.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPQuery.md index adaf44def8..e8de888124 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPQuery.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPQuery.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Executes the currently queued actions -## SYNTAX +## SYNTAX ```powershell Invoke-PnPQuery [-RetryCount ] @@ -77,4 +77,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPSPRestMethod.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPSPRestMethod.md index 506d2dafb8..159fabcaff 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPSPRestMethod.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPSPRestMethod.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Invokes a REST request towards a SharePoint site -## SYNTAX +## SYNTAX ```powershell Invoke-PnPSPRestMethod -Url @@ -128,4 +128,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPSiteDesign.md index a57f34f051..035b26dd12 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPSiteDesign.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPSiteDesign.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Apply a Site Design to an existing site. * Requires Tenant Administration Rights * -## SYNTAX +## SYNTAX ```powershell Invoke-PnPSiteDesign -Identity @@ -94,4 +94,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPWebAction.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPWebAction.md index 571ecf1fb5..081a968aa1 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPWebAction.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Invoke-PnPWebAction.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Executes operations on web, lists and list items. -## SYNTAX +## SYNTAX ```powershell Invoke-PnPWebAction [-Webs ] @@ -282,4 +282,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPList.md index 572c456457..a5c8dcddd5 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPList.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPList.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Returns statistics on the list object -## SYNTAX +## SYNTAX +### ```powershell Measure-PnPList -Identity [-Includes ] @@ -125,4 +126,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPResponseTime.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPResponseTime.md index 14b3ff30dd..0e9b4d6a2f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPResponseTime.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPResponseTime.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Gets statistics on response time for the specified endpoint by sending probe requests -## SYNTAX +## SYNTAX ```powershell Measure-PnPResponseTime [-Url ] @@ -133,4 +133,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPWeb.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPWeb.md index 02022bd09b..acf8495dac 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPWeb.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Measure-PnPWeb.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Returns statistics on the web object -## SYNTAX +## SYNTAX ```powershell Measure-PnPWeb [-Identity ] @@ -95,4 +95,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPClientSideComponent.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPClientSideComponent.md index bdf8cbc549..b22b0ef7b9 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPClientSideComponent.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPClientSideComponent.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Moves a Client-Side Component to a different section/column -## SYNTAX +## SYNTAX ### Move to other section ```powershell @@ -187,4 +187,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFile.md index 2ef557dc72..5d633d4f8a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFile.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFile.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Moves a file to a different location -## SYNTAX +## SYNTAX ### Server Relative ```powershell @@ -143,4 +143,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFolder.md index 66ac477997..b6525c5ccc 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFolder.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPFolder.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Move a folder to another location in the current web -## SYNTAX +## SYNTAX ```powershell Move-PnPFolder -Folder @@ -99,4 +99,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPItemProxy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPItemProxy.md index 44d2b442f5..22d5b8eda6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPItemProxy.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPItemProxy.md @@ -12,4 +12,4 @@ Proxy cmdlet for using Move-Item between SharePoint provider and FileSystem prov ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPListItemToRecycleBin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPListItemToRecycleBin.md index d03828e531..62dabf3813 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPListItemToRecycleBin.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnPListItemToRecycleBin.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Moves an item from a list to the Recycle Bin -## SYNTAX +## SYNTAX ```powershell Move-PnPListItemToRecycleBin -List @@ -93,4 +93,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnpRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnpRecycleBinItem.md index e533da970e..23f4ef01f1 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnpRecycleBinItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Move-PnpRecycleBinItem.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Moves all items or a specific item in the first stage recycle bin of the current site collection to the second stage recycle bin -## SYNTAX +## SYNTAX ```powershell Move-PnPRecycleBinItem [-Identity ] @@ -81,4 +81,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPAzureCertificate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPAzureCertificate.md index b3ea270140..e01602ffbc 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPAzureCertificate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPAzureCertificate.md @@ -18,7 +18,7 @@ Certificate contains the PEM encoded certificate. PrivateKey contains the PEM encoded private key of the certificate. -## SYNTAX +## SYNTAX ```powershell New-PnPAzureCertificate [-CommonName ] @@ -44,7 +44,7 @@ This will generate a default self-signed certificate named "pnp.contoso.com" val ### ------------------EXAMPLE 2------------------ ```powershell -New-PnPAzureCertificate -CommonName "My Certificate" -ValidYears 30 +New-PnPAzureCertificate -CommonName "My Certificate" -ValidYears 30 ``` This will output a certificate named "My Certificate" which expires in 30 years from now. @@ -173,4 +173,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPExtensibilityHandlerObject.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPExtensibilityHandlerObject.md index f7baa84746..4b9e187be3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPExtensibilityHandlerObject.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPExtensibilityHandlerObject.md @@ -8,9 +8,9 @@ schema: 2.0.0 # New-PnPExtensibilityHandlerObject ## SYNOPSIS -Creates an ExtensibilityHandler Object, to be used by the Get-SPOProvisioningTemplate cmdlet +Creates an ExtensibilityHandler Object, to be used by the Get-PnPProvisioningTemplate cmdlet -## SYNTAX +## SYNTAX ```powershell New-PnPExtensibilityHandlerObject -Assembly @@ -86,4 +86,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPGroup.md index 225dbeede0..79c82a13b4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPGroup.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPGroup.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds group to the Site Groups List and returns a group object -## SYNTAX +## SYNTAX ```powershell New-PnPGroup -Title @@ -162,4 +162,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPList.md index f47eeaa72d..aa04bb0ef6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPList.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPList.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a new list -## SYNTAX +## SYNTAX ```powershell New-PnPList -Title @@ -159,4 +159,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPPersonalSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPPersonalSite.md index 261e10d61e..1a0dfb513e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPPersonalSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPPersonalSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Office365 only: Creates a personal / OneDrive For Business site -## SYNTAX +## SYNTAX ```powershell New-PnPPersonalSite -Email @@ -55,4 +55,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplate.md index a7962efd65..d5dfcd73a4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplate.md @@ -21,4 +21,4 @@ Creates a new instance of a site template object. ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplateFromFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplateFromFolder.md index 4f425c5d01..92de20fd9e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplateFromFolder.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPProvisioningTemplateFromFolder.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Generates a provisioning template from a given folder, including only files that are present in that folder -## SYNTAX +## SYNTAX ```powershell New-PnPProvisioningTemplateFromFolder [-Out ] @@ -233,4 +233,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Encoding](https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Encoding](https://msdn.microsoft.com/en-us/library/system.text.encoding_properties.aspx) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPSite.md index dc58d82abd..2ca133b158 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPSite.md @@ -8,9 +8,9 @@ schema: 2.0.0 # New-PnPSite ## SYNOPSIS -Creates a new site collection +Creates either a communication site or an Office 365 group-connected team site -## SYNTAX +## SYNTAX ### Communication Site with Built-In Site Design ```powershell @@ -19,10 +19,12 @@ New-PnPSite -Title -Type [-Description ] [-Classification ] + [-Owner ] [-AllowFileSharingForGuestUsers []] [-SiteDesign ] [-Lcid ] [-HubSiteId ] + [-Wait []] [-Connection ] ``` @@ -37,6 +39,7 @@ New-PnPSite -Title [-IsPublic ] [-Owners ] [-HubSiteId ] + [-Wait []] [-Connection ] ``` @@ -48,14 +51,16 @@ New-PnPSite -Title -Type [-Description ] [-Classification ] + [-Owner ] [-AllowFileSharingForGuestUsers []] [-Lcid ] [-HubSiteId ] + [-Wait []] [-Connection ] ``` ## DESCRIPTION -The New-PnPSite cmdlet creates a new site collection for the current tenant. Currently only 'modern' sites like Communication Site and the Modern Team Site are supported. If you want to create a classic site, use New-PnPTenantSite. +The New-PnPSite cmdlet creates a new site collection for the current tenant. Currently only 'modern' sites like Communication Site and the Modern Office 365 group-connected team sites are supported. If you want to create a classic site, use New-PnPTenantSite. ## EXAMPLES @@ -208,6 +213,18 @@ Position: 0 Accept pipeline input: False ``` +### -Owner +Specifies the owner of the site. Specify the value as a string array: "user@domain.com" + +```yaml +Type: String +Parameter Sets: Communication Site with Built-In Site Design + +Required: False +Position: 0 +Accept pipeline input: False +``` + ### -Owners Specifies the owners of the site. Specify the value as a string array: "user@domain.com","anotheruser@domain.com" @@ -280,6 +297,18 @@ Position: 0 Accept pipeline input: False ``` +### -Wait +If specified the cmdlet will wait until the site has been fully created and all site artifacts have been provisioned by SharePoint. Notice that this can take a while. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -Connection Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. @@ -300,4 +329,4 @@ Returns the url of the newly created site collection ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequence.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequence.md index 000e5676aa..ea1edc5606 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequence.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequence.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a new tenant sequence object -## SYNTAX +## SYNTAX ```powershell New-PnPTenantSequence [-Id ] @@ -48,4 +48,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceCommunicationSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceCommunicationSite.md index 2b5c89d0a7..14123d09cf 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceCommunicationSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceCommunicationSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a communication site object -## SYNTAX +## SYNTAX ```powershell New-PnPTenantSequenceCommunicationSite -Url @@ -158,4 +158,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSite.md index 47c3685825..7b6075eb3c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a new team site without an Office 365 group in-memory object -## SYNTAX +## SYNTAX ```powershell New-PnPTenantSequenceTeamNoGroupSite -Url @@ -132,4 +132,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSubSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSubSite.md index 1134f4b7ac..a722a20bc6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSubSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamNoGroupSubSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a team site subsite with no Office 365 group object -## SYNTAX +## SYNTAX ```powershell New-PnPTenantSequenceTeamNoGroupSubSite -Url @@ -132,4 +132,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamSite.md index 366dbeaf85..883da3489b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSequenceTeamSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a team site object -## SYNTAX +## SYNTAX ```powershell New-PnPTenantSequenceTeamSite -Alias @@ -132,4 +132,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSite.md index cc32c1ff04..dee2281dee 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantSite.md @@ -8,9 +8,9 @@ schema: 2.0.0 # New-PnPTenantSite ## SYNOPSIS -Creates a new site collection for the current tenant +Creates a new (classic) site collection for the current tenant -## SYNTAX +## SYNTAX ```powershell New-PnPTenantSite -Title @@ -31,7 +31,7 @@ New-PnPTenantSite -Title ## DESCRIPTION The New-PnPTenantSite cmdlet creates a new site collection for the current company. However, creating a new SharePoint -Online site collection fails if a deleted site with the same URL exists in the Recycle Bin. If you want to use this command for an on-premises farm, please refer to http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx +Online site collection fails if a deleted site with the same URL exists in the Recycle Bin. If you want to use this command for an on-premises farm, please refer to http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx ## EXAMPLES @@ -64,7 +64,7 @@ Accept pipeline input: False ``` ### -Lcid -Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.splanguage.lcid.aspx. To get the list of supported languages use: (Get-PnPWeb -Includes RegionalSettings.InstalledLanguages).RegionalSettings.InstalledLanguages +Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.splanguage.lcid.aspx. To get the list of supported languages use: (Get-PnPWeb -Includes RegionalSettings.InstalledLanguages).RegionalSettings.InstalledLanguages ```yaml Type: UInt32 @@ -223,4 +223,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Locale IDs](https://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911)[Resource Usage Limits on Sandboxed Solutions in SharePoint 2010](https://msdn.microsoft.com/en-us/library/gg615462.aspx.)[Creating on-premises site collections using CSOM](https://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Locale IDs](http://go.microsoft.com/fwlink/p/?LinkId=242911Id=242911)[Resource Usage Limits on Sandboxed Solutions in SharePoint 2010](http://msdn.microsoft.com/en-us/library/gg615462.aspx.)[Creating on-premises site collections using CSOM](http://blogs.msdn.com/b/vesku/archive/2014/06/09/provisioning-site-collections-using-sp-app-model-in-on-premises-with-just-csom.aspx) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantTemplate.md index 264a9c5ebe..648a5906da 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTenantTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a new tenant template object -## SYNTAX +## SYNTAX ```powershell New-PnPTenantTemplate [-Author ] @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTerm.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTerm.md index 918e72f65c..032075b8f3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTerm.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTerm.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a taxonomy term -## SYNTAX +## SYNTAX ```powershell New-PnPTerm -Name @@ -34,17 +34,6 @@ New-PnPTerm -TermSet "Departments" -TermGroup "Corporate" -Name "Finance" Creates a new taxonomy term named "Finance" in the termset Departments which is located in the "Corporate" termgroup -### ------------------EXAMPLE 2------------------ -```powershell -$context = Get-PnPContext -$term = New-PnPTerm -Name "Finance" -TermSet "Departments" -TermGroup "Corporate" -LCID 1033 -$createLabel = $term.CreateLabel("Finanzwesen", 1031, $true) -$context.Load($term) -Invoke-PnPQuery -``` - -This example creates a new English taxonomy term named "Finance" in the termset "Departments" which is located in the "Corporate" termgroup and adds a German default label for the newly created English term by means of the **[CreateLabel](https://docs.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.taxonomy.term.createlabel)** method. - ## PARAMETERS ### -CustomProperties @@ -174,4 +163,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermGroup.md index 49730ba2d4..8c52a9b584 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermGroup.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermGroup.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a taxonomy term group -## SYNTAX +## SYNTAX ```powershell New-PnPTermGroup -Name @@ -100,4 +100,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermSet.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermSet.md index 668054eb6c..aa1fa7537a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermSet.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPTermSet.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a taxonomy term set -## SYNTAX +## SYNTAX ```powershell New-PnPTermSet -Name @@ -202,4 +202,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUPABulkImportJob.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUPABulkImportJob.md index b44003ac4d..3ce129857d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUPABulkImportJob.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUPABulkImportJob.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Submit up a new user profile bulk import job. -## SYNTAX +## SYNTAX ```powershell New-PnPUPABulkImportJob -Folder @@ -28,7 +28,7 @@ See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/bulk-user- ### ------------------EXAMPLE 1------------------ ```powershell -@" +@" { "value": [ { @@ -38,7 +38,7 @@ See https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/bulk-user- { "IdName": "vesaj@contoso.com", "Department": "PnP", - } + } ] } "@ > profiles.json @@ -124,4 +124,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUnifiedGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUnifiedGroup.md index 1e03f73ee7..6519444660 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUnifiedGroup.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUnifiedGroup.md @@ -8,9 +8,9 @@ schema: 2.0.0 # New-PnPUnifiedGroup ## SYNOPSIS -Creates a new Office 365 Group (aka Unified Group) +Creates a new Office 365 Group (aka Unified Group). Requires the Azure Active Directory application permission 'Group.ReadWrite.All'. -## SYNTAX +## SYNTAX ```powershell New-PnPUnifiedGroup -DisplayName @@ -166,4 +166,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUser.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUser.md index 73abe862ce..8456fd5bf0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUser.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPUser.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds a user to the built-in Site User Info List and returns a user object -## SYNTAX +## SYNTAX ```powershell New-PnPUser -LoginName @@ -72,4 +72,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPWeb.md b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPWeb.md index 09fbd833af..6935a25b8d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPWeb.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/New-PnPWeb.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Creates a new subweb under the current web -## SYNTAX +## SYNTAX ```powershell New-PnPWeb -Title @@ -149,4 +149,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Publish-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Publish-PnPApp.md index e3e008f379..54ec6fa9d7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Publish-PnPApp.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Publish-PnPApp.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Publishes/Deploys/Trusts an available app in the app catalog -## SYNTAX +## SYNTAX ```powershell Publish-PnPApp -Identity @@ -95,4 +95,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPProvisioningTemplate.md index 34e1794cb4..f43c2f8f14 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPProvisioningTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPProvisioningTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Loads/Reads a PnP file from the file system or a string -## SYNTAX +## SYNTAX ### By Path ```powershell @@ -87,4 +87,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPTenantTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPTenantTemplate.md index 89939f7322..05ef073285 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPTenantTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Read-PnPTenantTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Loads/Reads a PnP tenant template from the file system and returns an in-memory instance of this template. -## SYNTAX +## SYNTAX ```powershell Read-PnPTenantTemplate -Path @@ -54,4 +54,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Register-PnPHubSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Register-PnPHubSite.md index c579851b8e..c5d87bac1a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Register-PnPHubSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Register-PnPHubSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Registers a site as a hubsite -## SYNTAX +## SYNTAX ```powershell Register-PnPHubSite -Site @@ -57,4 +57,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPAlert.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPAlert.md index 1113bee600..6210ad25f1 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPAlert.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPAlert.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes an alert for a user -## SYNTAX +## SYNTAX ```powershell Remove-PnPAlert -Identity @@ -110,4 +110,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPApp.md index ed78c12e74..9cb6685360 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPApp.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPApp.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes an app from the app catalog -## SYNTAX +## SYNTAX ```powershell Remove-PnPApp -Identity @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPApplicationCustomizer.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPApplicationCustomizer.md new file mode 100644 index 0000000000..f03c3df326 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPApplicationCustomizer.md @@ -0,0 +1,140 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/remove-pnpapplicationcustomizer +applicable: SharePoint Online, SharePoint 2019 +schema: 2.0.0 +--- + +# Remove-PnPApplicationCustomizer + +## SYNOPSIS +Removes a SharePoint Framework client side extension application customizer + +## SYNTAX + +### Custom Action Id +```powershell +Remove-PnPApplicationCustomizer [-Identity ] + [-Scope ] + [-Force []] + [-Web ] + [-Connection ] +``` + +### Client Side Component Id +```powershell +Remove-PnPApplicationCustomizer -ClientSideComponentId + [-Scope ] + [-Force []] + [-Web ] + [-Connection ] +``` + +## DESCRIPTION +Removes a SharePoint Framework client side extension application customizer by removing a user custom action from a web or sitecollection + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Remove-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 +``` + +Removes the custom action representing the client side extension registration with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'. + +### ------------------EXAMPLE 2------------------ +```powershell +Remove-PnPCustomAction -ClientSideComponentId aa66f67e-46c0-4474-8a82-42bf467d07f2 -Scope web +``` + +Removes the custom action(s) being registered for a SharePoint Framework solution having the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' in its manifest from the current web. + +## PARAMETERS + +### -ClientSideComponentId +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 + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: GuidPipeBind +Parameter Sets: Client Side Component Id + +Required: True +Position: Named +Accept pipeline input: False +``` + +### -Force +Use the -Force flag to bypass the confirmation question + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Identity +The id or name of the CustomAction representing the client side extension registration that needs to be removed or a CustomAction instance itself + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: UserCustomActionPipeBind +Parameter Sets: Custom Action Id + +Required: False +Position: 0 +Accept pipeline input: True +``` + +### -Scope +Define if the CustomAction representing the client side extension registration is to be found at the web or site collection scope. Specify All to allow deletion from either web or site collection (default). + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: CustomActionScope +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Web +This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: WebPipeBind +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSideComponent.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSideComponent.md index c72943b08a..30bdc0e9b7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSideComponent.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSideComponent.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a Client-Side component from a page -## SYNTAX +## SYNTAX ```powershell Remove-PnPClientSideComponent -Page @@ -103,4 +103,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSidePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSidePage.md index 38b27a5415..d27b6d067b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSidePage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPClientSidePage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a Client-Side Page -## SYNTAX +## SYNTAX ```powershell Remove-PnPClientSidePage -Identity @@ -102,4 +102,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentType.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentType.md index b7f420c2a8..cd8778821b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentType.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentType.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a content type from a web -## SYNTAX +## SYNTAX ```powershell Remove-PnPContentType -Identity @@ -87,4 +87,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromDocumentSet.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromDocumentSet.md index 0dcb11d0e9..a9cc8076c2 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromDocumentSet.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromDocumentSet.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a content type from a document set -## SYNTAX +## SYNTAX ```powershell Remove-PnPContentTypeFromDocumentSet -ContentType @@ -87,4 +87,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromList.md index 0ade1d5e10..3154949dc0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromList.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPContentTypeFromList.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a content type from a list -## SYNTAX +## SYNTAX ```powershell Remove-PnPContentTypeFromList -List @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPCustomAction.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPCustomAction.md index 2352c90838..207e47c369 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPCustomAction.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPCustomAction.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a custom action -## SYNTAX +## SYNTAX ```powershell Remove-PnPCustomAction [-Identity ] @@ -114,4 +114,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPDeletedUnifiedGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPDeletedUnifiedGroup.md new file mode 100644 index 0000000000..56b68e5ff8 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPDeletedUnifiedGroup.md @@ -0,0 +1,52 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/remove-pnpdeletedunifiedgroup +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Remove-PnPDeletedUnifiedGroup + +## SYNOPSIS +Permanently removes one deleted Office 365 Group (aka Unified Group) + +## SYNTAX + +```powershell +Remove-PnPDeletedUnifiedGroup -Identity +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Remove-PnPDeletedUnifiedGroup -Identity 38b32e13-e900-4d95-b860-fb52bc07ca7f +``` + +Permanently removes a deleted Office 365 Group based on its ID + +### ------------------EXAMPLE 2------------------ +```powershell +$group = Get-PnPDeletedUnifiedGroup -Identity 38b32e13-e900-4d95-b860-fb52bc07ca7f +Remove-PnPDeletedUnifiedGroup -Identity $group +``` + +Permanently removes the provided deleted Office 365 Group + +## PARAMETERS + +### -Identity +The Identity of the deleted Office 365 Group + +```yaml +Type: UnifiedGroupPipeBind +Parameter Sets: (All) + +Required: True +Position: Named +Accept pipeline input: True +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPEventReceiver.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPEventReceiver.md index 9fea0000c9..adc1ae8596 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPEventReceiver.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPEventReceiver.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Remove an eventreceiver -## SYNTAX +## SYNTAX ### List ```powershell @@ -132,4 +132,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPField.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPField.md index b4b4001ef2..7b495011a7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPField.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPField.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a field from a list or a site -## SYNTAX +## SYNTAX ```powershell Remove-PnPField -Identity @@ -100,4 +100,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFieldFromContentType.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFieldFromContentType.md index 379afa1b04..6ed5442139 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFieldFromContentType.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFieldFromContentType.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a site column from a content type -## SYNTAX +## SYNTAX ```powershell Remove-PnPFieldFromContentType -Field @@ -100,4 +100,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFile.md index 420a35f2b8..65462a94b5 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFile.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFile.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a file. -## SYNTAX +## SYNTAX ### Server Relative ```powershell @@ -129,4 +129,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFileFromProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFileFromProvisioningTemplate.md index 8756d0ebdb..1c80067d78 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFileFromProvisioningTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFileFromProvisioningTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a file from a PnP Provisioning Template -## SYNTAX +## SYNTAX ```powershell Remove-PnPFileFromProvisioningTemplate -Path @@ -67,4 +67,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFolder.md index 6a78685704..f7ece9ba9a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFolder.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPFolder.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Deletes a folder within a parent folder -## SYNTAX +## SYNTAX ```powershell Remove-PnPFolder -Name @@ -113,4 +113,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPGroup.md index 2284f71c26..1ab6a31f46 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPGroup.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPGroup.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a group from a web. -## SYNTAX +## SYNTAX ```powershell Remove-PnPGroup [-Identity ] @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPHomeSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPHomeSite.md index 52cb621810..66eb1e40b0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPHomeSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPHomeSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes the currently set site as the home site -## SYNTAX +## SYNTAX ```powershell Remove-PnPHomeSite [-Force []] @@ -54,4 +54,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPHubSiteAssociation.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPHubSiteAssociation.md index 68ffc69a5d..b68da37aec 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPHubSiteAssociation.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPHubSiteAssociation.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Disconnects a site from a hubsite. -## SYNTAX +## SYNTAX ```powershell Remove-PnPHubSiteAssociation -Site @@ -57,4 +57,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPIndexedProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPIndexedProperty.md index 4d3a392f5f..76a2eaa32a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPIndexedProperty.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPIndexedProperty.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a key from propertybag to be indexed by search. The key and it's value remain in the propertybag, however it will not be indexed anymore. -## SYNTAX +## SYNTAX ```powershell Remove-PnPIndexedProperty -Key @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPJavaScriptLink.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPJavaScriptLink.md index baaa27385a..14bc845fe0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPJavaScriptLink.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPJavaScriptLink.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a JavaScript link or block from a web or sitecollection -## SYNTAX +## SYNTAX ```powershell Remove-PnPJavaScriptLink [-Identity ] @@ -129,4 +129,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPList.md index a4e987e60c..d084c2893f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPList.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPList.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Deletes a list -## SYNTAX +## SYNTAX ```powershell Remove-PnPList -Identity @@ -107,4 +107,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPListItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPListItem.md index 85c8f1b77e..d6f7f5d2da 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPListItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPListItem.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Deletes an item from a list -## SYNTAX +## SYNTAX ```powershell Remove-PnPListItem -List @@ -113,4 +113,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPNavigationNode.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPNavigationNode.md index cf297ca009..ecbfa80987 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPNavigationNode.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPNavigationNode.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a menu item from either the quicklaunch or top navigation -## SYNTAX +## SYNTAX ### Remove a node by ID ```powershell @@ -130,4 +130,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPOrgAssetsLibrary.md new file mode 100644 index 0000000000..99af1e0fd6 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPOrgAssetsLibrary.md @@ -0,0 +1,100 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/remove-pnporgassetslibrary +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Remove-PnPOrgAssetsLibrary + +## SYNOPSIS +Removes a given document library as a organizational asset source + +## SYNTAX + +```powershell +Remove-PnPOrgAssetsLibrary -LibraryUrl + [-ShouldRemoveFromCdn ] + [-CdnType ] + [-Connection ] +``` + +## DESCRIPTION +Removes a given document library as a organizational asset source based on its server relative URL in your Sharepoint Online Tenant. It will not remove the document library itself. It may take some time before this change will be reflected in the webinterface. + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Remove-PnPOrgAssetsLibrary -LibraryUrl "sites/branding/logos" +``` + +This example removes the document library with the url "logos" residing in the sitecollection with the url "sites/branding/logos" from the list with organizational assets keeping it as an Office 365 CDN source + +### ------------------EXAMPLE 2------------------ +```powershell +Remove-PnPOrgAssetsLibrary -LibraryUrl "sites/branding/logos" -ShouldRemoveFromCdn $true +``` + +This example removes the document library with the url "logos" residing in the sitecollection with the url "sites/branding/logos" from the list with organizational assets also removing it as a Public Office 365 CDN source + +### ------------------EXAMPLE 3------------------ +```powershell +Remove-PnPOrgAssetsLibrary -LibraryUrl "sites/branding/logos" -ShouldRemoveFromCdn $true -CdnType Private +``` + +This example removes the document library with the url "logos" residing in the sitecollection with the url "sites/branding/logos" from the list with organizational assets also removing it as a Private Office 365 CDN source + +## PARAMETERS + +### -CdnType +Indicates what type of Office 365 CDN source the document library that will no longer be flagged as an organizational asset was of + +```yaml +Type: SPOTenantCdnType +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -LibraryUrl +The server relative url of the document library flagged as organizational asset which you want to remove, i.e. "sites/branding/logos" + +```yaml +Type: String +Parameter Sets: (All) + +Required: True +Position: Named +Accept pipeline input: False +``` + +### -ShouldRemoveFromCdn +Boolean indicating if the document library that will no longer be flagged as an organizational asset also needs to be removed as an Office 365 CDN source + +```yaml +Type: Boolean +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPOrgNewsSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPOrgNewsSite.md new file mode 100644 index 0000000000..4de8bdcc18 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPOrgNewsSite.md @@ -0,0 +1,60 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/remove-pnporgnewssite +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Remove-PnPOrgNewsSite + +## SYNOPSIS +Removes a given site from the list of organizational news sites. + +## SYNTAX + +```powershell +Remove-PnPOrgNewsSite -OrgNewsSiteUrl + [-Connection ] +``` + +## DESCRIPTION +Removes a given site from the list of organizational news sites based on its URL in your Sharepoint Online Tenant. + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Remove-PnPOrgNewsSite -OrgNewsSiteUrl https://tenant.sharepoint.com/sites/mysite +``` + +This example removes the specified site from list of organization's news sites. + +## PARAMETERS + +### -OrgNewsSiteUrl +The site to be removed from list of organization's news sites + +```yaml +Type: SitePipeBind +Parameter Sets: (All) + +Required: True +Position: Named +Accept pipeline input: False +``` + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPropertyBagValue.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPropertyBagValue.md index 29b61a9a9b..a6532cd627 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPropertyBagValue.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPropertyBagValue.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a value from the property bag -## SYNTAX +## SYNTAX ```powershell Remove-PnPPropertyBagValue -Key @@ -107,4 +107,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPublishingImageRendition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPublishingImageRendition.md index 847e8dba5e..a04ca77d5c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPublishingImageRendition.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPPublishingImageRendition.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes an existing image rendition -## SYNTAX +## SYNTAX ```powershell Remove-PnPPublishingImageRendition -Identity @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPRoleDefinition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPRoleDefinition.md index 9d2dcaa532..cc57c2a87f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPRoleDefinition.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPRoleDefinition.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Remove a Role Definition from a site -## SYNTAX +## SYNTAX ```powershell Remove-PnPRoleDefinition -Identity @@ -67,4 +67,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSearchConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSearchConfiguration.md index d5526b25bb..4e0f08dcb4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSearchConfiguration.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSearchConfiguration.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Remove the search configuration -## SYNTAX +## SYNTAX ### Config ```powershell @@ -122,4 +122,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteClassification.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteClassification.md index 7d74353d21..1486771025 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteClassification.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteClassification.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes one or more existing site classification values from the list of available values. Requires a connection to the Microsoft Graph -## SYNTAX +## SYNTAX ```powershell Remove-PnPSiteClassification -Classifications @@ -63,4 +63,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAdmin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAdmin.md index d2c610bf2c..83d543503d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAdmin.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAdmin.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes one or more users as site collection administrators from the site collection in the current context -## SYNTAX +## SYNTAX ```powershell Remove-PnPSiteCollectionAdmin -Owners @@ -78,4 +78,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAppCatalog.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAppCatalog.md index 684568a592..ba40c9e6fa 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAppCatalog.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteCollectionAppCatalog.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a Site Collection scoped App Catalog from a site -## SYNTAX +## SYNTAX ```powershell Remove-PnPSiteCollectionAppCatalog -Site @@ -24,7 +24,7 @@ Notice that this will not remove the App Catalog list and its contents from the ### ------------------EXAMPLE 1------------------ ```powershell -Remove-PnPOffice365GroupToSite -Url "https://contoso.sharepoint.com/sites/FinanceTeamsite" +Remove-PnPSiteCollectionAppCatalog -Site "https://contoso.sharepoint.com/sites/FinanceTeamsite" ``` This will remove a SiteCollection app catalog from the specified site @@ -57,4 +57,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesign.md index 687b023edf..56d1ebb08d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesign.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesign.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a Site Design -## SYNTAX +## SYNTAX ```powershell Remove-PnPSiteDesign -Identity @@ -67,4 +67,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesignTask.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesignTask.md index 2c0ce8d9a3..a4d62314b0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesignTask.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteDesignTask.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a Site Design Task. If the execution of the associated site script has already started the execution will not be terminated. -## SYNTAX +## SYNTAX ```powershell Remove-PnPSiteDesignTask -Identity @@ -67,4 +67,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteScript.md index 773c275451..08140e58d3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteScript.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPSiteScript.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a Site Script -## SYNTAX +## SYNTAX ```powershell Remove-PnPSiteScript -Identity @@ -67,4 +67,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStorageEntity.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStorageEntity.md index 839fe4f0dc..ee381e6494 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStorageEntity.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStorageEntity.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Remove Storage Entities / Farm Properties from either the tenant scoped app catalog or the current site collection if the site has a site collection scoped app catalog -## SYNTAX +## SYNTAX ```powershell Remove-PnPStorageEntity -Key @@ -22,7 +22,7 @@ Remove-PnPStorageEntity -Key ### ------------------EXAMPLE 1------------------ ```powershell -Remove-PnPStorageEntity -Key MyKey +Remove-PnPStorageEntity -Key MyKey ``` Removes an existing storage entity / farm property @@ -74,4 +74,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStoredCredential.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStoredCredential.md index aabb23dd6c..bf275e220c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStoredCredential.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPStoredCredential.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a credential -## SYNTAX +## SYNTAX ```powershell Remove-PnPStoredCredential -Name @@ -57,4 +57,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTaxonomyItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTaxonomyItem.md index 90381fea69..8b62b48ed0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTaxonomyItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTaxonomyItem.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a taxonomy item -## SYNTAX +## SYNTAX ```powershell Remove-PnPTaxonomyItem -TermPath @@ -59,4 +59,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantCdnOrigin.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantCdnOrigin.md index 760b3732a4..c00153ccd8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantCdnOrigin.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantCdnOrigin.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes an origin from the Public or Private content delivery network (CDN). -## SYNTAX +## SYNTAX ```powershell Remove-PnPTenantCdnOrigin -OriginUrl @@ -72,4 +72,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantSite.md index be25dffc73..671a69f02d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a site collection -## SYNTAX +## SYNTAX ```powershell Remove-PnPTenantSite -Url @@ -98,4 +98,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantTheme.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantTheme.md index 2fb6794851..9e0645e70a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantTheme.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTenantTheme.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a theme -## SYNTAX +## SYNTAX ```powershell Remove-PnPTenantTheme -Identity @@ -58,4 +58,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTermGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTermGroup.md index 0b4ad4dcee..15a08d922f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTermGroup.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPTermGroup.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a taxonomy term group and all its containing termsets -## SYNTAX +## SYNTAX ```powershell Remove-PnPTermGroup -GroupName @@ -71,4 +71,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUnifiedGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUnifiedGroup.md index e36516d6d6..a2bc6865f8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUnifiedGroup.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUnifiedGroup.md @@ -8,9 +8,9 @@ schema: 2.0.0 # Remove-PnPUnifiedGroup ## SYNOPSIS -Removes one Office 365 Group (aka Unified Group) +Removes one Office 365 Group (aka Unified Group). Requires the Azure Active Directory application permission 'Group.ReadWrite.All'. -## SYNTAX +## SYNTAX ```powershell Remove-PnPUnifiedGroup -Identity @@ -55,4 +55,4 @@ Accept pipeline input: True ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUser.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUser.md index d627c1fe73..6ed22d5e31 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUser.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUser.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a specific user from the site collection User Information List -## SYNTAX +## SYNTAX ```powershell Remove-PnPUser -Identity @@ -121,4 +121,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUserFromGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUserFromGroup.md index f8d3e446ff..54a67ac5b3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUserFromGroup.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPUserFromGroup.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a user from a group -## SYNTAX +## SYNTAX ```powershell Remove-PnPUserFromGroup -LoginName @@ -82,4 +82,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPView.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPView.md index f8b0b8550b..04b0ea49e9 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPView.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPView.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Deletes a view from a list -## SYNTAX +## SYNTAX ```powershell Remove-PnPView -Identity @@ -93,4 +93,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWeb.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWeb.md index 9768bd911e..c79801e39a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWeb.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWeb.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a subweb in the current web -## SYNTAX +## SYNTAX ### ByUrl ```powershell @@ -115,4 +115,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebPart.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebPart.md index 3ffaee4d08..c50d43dfe7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebPart.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebPart.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a web part from a page -## SYNTAX +## SYNTAX ### ID ```powershell @@ -110,4 +110,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebhookSubscription.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebhookSubscription.md index 48a0e4a2af..405ef5565e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebhookSubscription.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWebhookSubscription.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a Webhook subscription from the resource -## SYNTAX +## SYNTAX ```powershell Remove-PnPWebhookSubscription -Identity @@ -113,4 +113,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWikiPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWikiPage.md index ed6e8855cf..15aeb2871d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWikiPage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWikiPage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a wiki page -## SYNTAX +## SYNTAX ### SERVER ```powershell @@ -88,4 +88,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowDefinition.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowDefinition.md index 4880514fa3..64c9bf7904 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowDefinition.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowDefinition.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes a workflow definition -## SYNTAX +## SYNTAX ```powershell Remove-PnPWorkflowDefinition -Identity @@ -74,4 +74,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowSubscription.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowSubscription.md index ce03236010..133356a252 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowSubscription.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Remove-PnPWorkflowSubscription.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Remove workflow subscription -## SYNTAX +## SYNTAX ```powershell Remove-PnPWorkflowSubscription -Identity @@ -77,4 +77,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFile.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFile.md index f2a8a46d8b..64e2526bb1 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFile.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFile.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Renames a file in its current location -## SYNTAX +## SYNTAX ### SERVER ```powershell @@ -143,4 +143,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFolder.md index cdee8253f5..440cca57e8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFolder.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Rename-PnPFolder.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Renames a folder -## SYNTAX +## SYNTAX ```powershell Rename-PnPFolder -Folder @@ -88,4 +88,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPAccessToken.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPAccessToken.md new file mode 100644 index 0000000000..fac6cdc0df --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPAccessToken.md @@ -0,0 +1,168 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/request-pnpaccesstoken +applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +schema: 2.0.0 +--- + +# Request-PnPAccessToken + +## SYNOPSIS +Requests an OAuth Access token + +## SYNTAX + +```powershell +Request-PnPAccessToken [-ClientId ] + [-Resource ] + [-Scopes ] + [-Decoded []] + [-SetAsCurrent []] + [-Credentials ] + [-TenantUrl ] +``` + +## DESCRIPTION +Returns an access token using the password grant, using the PnP O365 Management Shell client id by default and the AllSites.FullControl scope by default. + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Request-PnPAccessToken +``` + +Returns the access token using the default client id and scope + +### ------------------EXAMPLE 2------------------ +```powershell +Request-PnPAccessToken -ClientId 26e29fec-aa10-4f99-8381-d96cddc650c2 +``` + +Returns the access token using the specified client id and the default scope of AllSites.FullControl + +### ------------------EXAMPLE 3------------------ +```powershell +Request-PnPAccessToken -ClientId 26e29fec-aa10-4f99-8381-d96cddc650c2 -Scopes Group.ReadWrite.All +``` + +Returns the access token using the specified client id and the specified scope + +### ------------------EXAMPLE 4------------------ +```powershell +Request-PnPAccessToken -ClientId 26e29fec-aa10-4f99-8381-d96cddc650c2 -Scopes Group.ReadWrite.All, AllSites.FullControl +``` + +Returns the access token using the specified client id and the specified scopes + +### ------------------EXAMPLE 5------------------ +```powershell +$token = Request-PnPAccessToken -ClientId 26e29fec-aa10-4f99-8381-d96cddc650c2 -Resource https://contoso.sharepoint.com -Credentials (Get-Credential) -TenantUrl https://contoso.sharepoint.com + Connect-PnPOnline -AccessToken $token +``` + +Returns the access token using the specified client id and the specified scopes while using the credentials and tenanturl specified to authentication against Azure AD + +## PARAMETERS + +### -ClientId +The Azure Application Client Id to use to retrieve the token. Defaults to the PnP Office 365 Management Shell + +Only applicable to: SharePoint Online + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Credentials +Optional credentials to use when retrieving the access token. If not present you need to connect first with Connect-PnPOnline. + +Only applicable to: SharePoint Online + +```yaml +Type: PSCredential +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Decoded +Returns the token in a decoded / human readible manner + +Only applicable to: SharePoint Online + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Resource +The scopes to retrieve the token for. Defaults to AllSites.FullControl + +Only applicable to: SharePoint Online + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Scopes +The scopes to retrieve the token for. Defaults to AllSites.FullControl + +Only applicable to: SharePoint Online + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -SetAsCurrent +Set this token as the current token to use when performing Azure AD based authentication requests with PnP PowerShell + +Only applicable to: SharePoint Online + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -TenantUrl +Optional tenant URL to use when retrieving the access token. The Url should be in the shape of https://yourtenant.sharepoint.com. See examples for more info. + +Only applicable to: SharePoint Online + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexList.md index 6a296d9780..6b5ad76fd2 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexList.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexList.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Marks the list for full indexing during the next incremental crawl -## SYNTAX +## SYNTAX ```powershell Request-PnPReIndexList -Identity @@ -67,4 +67,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexWeb.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexWeb.md index 6853cfeedc..a1493d53c5 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexWeb.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Request-PnPReIndexWeb.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Marks the web for full indexing during the next incremental crawl -## SYNTAX +## SYNTAX ```powershell Request-PnPReIndexWeb [-Web ] @@ -45,4 +45,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Reset-PnPFileVersion.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Reset-PnPFileVersion.md index 9894ad018f..eb19380f01 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Reset-PnPFileVersion.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Reset-PnPFileVersion.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Resets a file to its previous version -## SYNTAX +## SYNTAX ```powershell Reset-PnPFileVersion -ServerRelativeUrl @@ -100,4 +100,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Reset-PnPLabel.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Reset-PnPLabel.md new file mode 100644 index 0000000000..c34863d4d4 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Reset-PnPLabel.md @@ -0,0 +1,90 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/reset-pnplabel +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Reset-PnPLabel + +## SYNOPSIS +Resets a label/tag on the specified list or library to None + +## SYNTAX + +```powershell +Reset-PnPLabel -List + [-SyncToItems ] + [-Web ] + [-Connection ] +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Reset-PnPLabel -List "Demo List" +``` + +This resets an O365 label on the specified list or library to None + +### ------------------EXAMPLE 2------------------ +```powershell +Reset-PnPLabel -List "Demo List" -SyncToItems $true +``` + +This resets an O365 label on the specified list or library to None and resets the label on all the items in the list and library except Folders and where the label has been manually or previously automatically assigned + +## PARAMETERS + +### -List +The ID or Url of the list + +```yaml +Type: ListPipeBind +Parameter Sets: (All) + +Required: True +Position: 0 +Accept pipeline input: True +``` + +### -SyncToItems +Reset label on existing items in the library + +```yaml +Type: Boolean +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Web +This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. + +```yaml +Type: WebPipeBind +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Resolve-PnPFolder.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Resolve-PnPFolder.md index 668a7cf492..6d8c38e71a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Resolve-PnPFolder.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Resolve-PnPFolder.md @@ -10,8 +10,9 @@ schema: 2.0.0 ## SYNOPSIS Returns a folder from a given site relative path, and will create it if it does not exist. -## SYNTAX +## SYNTAX +### ```powershell Resolve-PnPFolder -SiteRelativePath [-Includes ] @@ -87,4 +88,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Get-PnPFolder](https://github.com/OfficeDev/PnP-PowerShell/blob/master/Documentation/GetPnPFolder.md) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp)[Get-PnPFolder](https://github.com/OfficeDev/PnP-PowerShell/blob/master/Documentation/GetPnPFolder.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnPDeletedUnifiedGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnPDeletedUnifiedGroup.md new file mode 100644 index 0000000000..4804eb3a51 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnPDeletedUnifiedGroup.md @@ -0,0 +1,52 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/restore-pnpdeletedunifiedgroup +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Restore-PnPDeletedUnifiedGroup + +## SYNOPSIS +Restores one deleted Office 365 Group (aka Unified Group) + +## SYNTAX + +```powershell +Restore-PnPDeletedUnifiedGroup -Identity +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Restore-PnPDeletedUnifiedGroup -Identity 38b32e13-e900-4d95-b860-fb52bc07ca7f +``` + +Restores a deleted Office 365 Group based on its ID + +### ------------------EXAMPLE 2------------------ +```powershell +$group = Get-PnPDeletedUnifiedGroup -Identity 38b32e13-e900-4d95-b860-fb52bc07ca7f +Restore-PnPDeletedUnifiedGroup -Identity $group +``` + +Restores the provided deleted Office 365 Group + +## PARAMETERS + +### -Identity +The Identity of the deleted Office 365 Group + +```yaml +Type: UnifiedGroupPipeBind +Parameter Sets: (All) + +Required: True +Position: Named +Accept pipeline input: True +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnPTenantRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnPTenantRecycleBinItem.md index da2444eb9e..eba0907370 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnPTenantRecycleBinItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnPTenantRecycleBinItem.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Restores a site collection from the tenant scoped recycle bin -## SYNTAX +## SYNTAX ```powershell Restore-PnPTenantRecycleBinItem -Url @@ -20,20 +20,20 @@ Restore-PnPTenantRecycleBinItem -Url ``` ## DESCRIPTION -The Reset-PnPTenantRecycleBinItem cmdlet allows a site collection that has been deleted and still exists in the tenant recycle bin to be restored to its original location. +The Restore-PnPTenantRecycleBinItem cmdlet allows a site collection that has been deleted and still exists in the tenant recycle bin to be restored to its original location. ## EXAMPLES ### ------------------EXAMPLE 1------------------ ```powershell -Reset-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso +Restore-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso ``` This will restore the deleted site collection with the url 'https://tenant.sharepoint.com/sites/contoso' to its original location ### ------------------EXAMPLE 2------------------ ```powershell -Reset-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso -Wait +Restore-PnPTenantRecycleBinItem -Url https://tenant.sharepoint.com/sites/contoso -Wait ``` This will restore the deleted site collection with the url 'https://tenant.sharepoint.com/sites/contoso' to its original location and will wait with executing further PowerShell commands until the site collection restore has completed @@ -90,4 +90,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnpRecycleBinItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnpRecycleBinItem.md index 0bfd2532a7..8e8b61cbcb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnpRecycleBinItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Restore-PnpRecycleBinItem.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Restores the provided recycle bin item to its original location -## SYNTAX +## SYNTAX ### Identity ```powershell @@ -45,7 +45,7 @@ Restores all the items in the first and second stage recycle bins to their origi ## PARAMETERS ### -All -If provided all items will be stored +If provided all items will be stored ```yaml Type: SwitchParameter @@ -94,4 +94,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Resume-PnPWorkflowInstance.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Resume-PnPWorkflowInstance.md index b849654829..cb0eb89952 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Resume-PnPWorkflowInstance.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Resume-PnPWorkflowInstance.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Resume a workflow -## SYNTAX +## SYNTAX ```powershell Resume-PnPWorkflowInstance -Identity @@ -70,4 +70,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPSiteDesignRights.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPSiteDesignRights.md index 49b461a3ff..726c270d7a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPSiteDesignRights.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPSiteDesignRights.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Revokes the specified principals rights to use the site design. -## SYNTAX +## SYNTAX ```powershell Revoke-PnPSiteDesignRights -Identity @@ -74,4 +74,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPTenantServicePrincipalPermission.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPTenantServicePrincipalPermission.md index 2f07f0b4e9..3fe27c583d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPTenantServicePrincipalPermission.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Revoke-PnPTenantServicePrincipalPermission.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Revokes a permission that was previously granted to the "SharePoint Online Client" service principal. -## SYNTAX +## SYNTAX ```powershell Revoke-PnPTenantServicePrincipalPermission -ObjectId @@ -61,4 +61,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPClientSidePageConversionLog.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPClientSidePageConversionLog.md index 2eef79760d..b2ad38f006 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPClientSidePageConversionLog.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPClientSidePageConversionLog.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Persists the current client side page conversion log data to the loggers linked to the last used page transformation run. Needs to be used in conjunction with the -LogSkipFlush flag on the ConvertTo-PnPClientSidePage cmdlet -## SYNTAX +## SYNTAX ```powershell Save-PnPClientSidePageConversionLog [-Web ] @@ -54,4 +54,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPProvisioningTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPProvisioningTemplate.md index ef0a7d2d8b..1b1e802647 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPProvisioningTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPProvisioningTemplate.md @@ -10,10 +10,10 @@ schema: 2.0.0 ## SYNOPSIS Saves a PnP site template to the file system -## SYNTAX +## SYNTAX ```powershell -Save-PnPProvisioningTemplate -InputInstance +Save-PnPProvisioningTemplate -Template -Out [-Force []] [-TemplateProviderExtensions ] @@ -42,27 +42,28 @@ Position: Named Accept pipeline input: False ``` -### -InputInstance -Allows you to provide an in-memory instance of the ProvisioningTemplate type of the PnP Core Component. When using this parameter, the -Out parameter refers to the path for saving the template and storing any supporting file for the template. +### -Out +Filename to write to, optionally including full path. ```yaml -Type: ProvisioningTemplate +Type: String Parameter Sets: (All) Required: True -Position: Named +Position: 0 Accept pipeline input: False ``` -### -Out -Filename to write to, optionally including full path. +### -Template +Allows you to provide an in-memory instance of the ProvisioningTemplate type of the PnP Core Component. When using this parameter, the -Out parameter refers to the path for saving the template and storing any supporting file for the template. ```yaml -Type: String +Type: ProvisioningTemplate Parameter Sets: (All) +Aliases: InputInstance Required: True -Position: 0 +Position: Named Accept pipeline input: False ``` @@ -80,4 +81,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPTenantTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPTenantTemplate.md index 11895ebc45..c897ccf9cf 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPTenantTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Save-PnPTenantTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Saves a PnP provisioning hierarchy to the file system -## SYNTAX +## SYNTAX ```powershell Save-PnPTenantTemplate -Template @@ -22,7 +22,7 @@ Save-PnPTenantTemplate -Template ### ------------------EXAMPLE 1------------------ ```powershell -Save-PnPTenantTemplate -Template $template -Out .\hierarchy.pnp +Save-PnPTenantTemplate -Template $template -Out .\tenanttemplate.pnp ``` Saves a PnP tenant template to the file system @@ -59,7 +59,6 @@ Allows you to provide an in-memory instance of a Tenant Template. When using thi ```yaml Type: ProvisioningHierarchy Parameter Sets: (All) -Aliases: Hierarchy Required: True Position: Named @@ -68,4 +67,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Send-PnPMail.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Send-PnPMail.md index f2f893667d..6267e3196e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Send-PnPMail.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Send-PnPMail.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sends an email using the Office 365 SMTP Service or SharePoint, depending on the parameters specified. See detailed help for more information. -## SYNTAX +## SYNTAX ```powershell Send-PnPMail -To @@ -159,4 +159,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAppSideLoading.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAppSideLoading.md index 3b45cfa02d..3940edf97c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAppSideLoading.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAppSideLoading.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Enables the App SideLoading Feature on a site -## SYNTAX +## SYNTAX ### On ```powershell @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPApplicationCustomizer.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPApplicationCustomizer.md new file mode 100644 index 0000000000..5a8e9b6b80 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPApplicationCustomizer.md @@ -0,0 +1,188 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/set-pnpapplicationcustomizer +applicable: SharePoint Online, SharePoint 2019 +schema: 2.0.0 +--- + +# Set-PnPApplicationCustomizer + +## SYNOPSIS +Updates a SharePoint Framework client side extension application customizer + +## SYNTAX + +### Custom Action Id +```powershell +Set-PnPApplicationCustomizer [-Identity ] + [-Scope ] + [-Title ] + [-Description ] + [-Sequence ] + [-ClientSideComponentProperties ] + [-Web ] + [-Connection ] +``` + +### Client Side Component Id +```powershell +Set-PnPApplicationCustomizer [-ClientSideComponentId ] + [-Scope ] + [-Title ] + [-Description ] + [-Sequence ] + [-ClientSideComponentProperties ] + [-Web ] + [-Connection ] +``` + +## DESCRIPTION +Updates a SharePoint Framework client side extension application customizer by updating its custom action. Only the properties that will be provided will be updated. Others will remain as they are. + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Set-PnPCustomAction -Identity aa66f67e-46c0-4474-8a82-42bf467d07f2 +``` + +Updates the custom action representing the client side extension registration with the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2'. + +### ------------------EXAMPLE 2------------------ +```powershell +Set-PnPCustomAction -ClientSideComponentId aa66f67e-46c0-4474-8a82-42bf467d07f2 -Scope web -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"} +``` + +Updates the custom action(s) properties being registered for a SharePoint Framework solution having the id 'aa66f67e-46c0-4474-8a82-42bf467d07f2' in its manifest from the current web. + +## PARAMETERS + +### -ClientSideComponentId +The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest for which existing custom action(s) should be updated + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: GuidPipeBind +Parameter Sets: Client Side Component Id + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -ClientSideComponentProperties +The Client Side Component Properties of the application customizer to update. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}". Omit to not update this property. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Description +The description of the application customizer. Omit to not update this property. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Identity +The id or name of the CustomAction representing the client side extension registration that needs to be updated or a CustomAction instance itself + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: UserCustomActionPipeBind +Parameter Sets: Custom Action Id + +Required: False +Position: 0 +Accept pipeline input: True +``` + +### -Scope +Define if the CustomAction representing the client side extension registration is to be found at the web or site collection scope. Specify All to update the component on both web and site collection level. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: CustomActionScope +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Sequence +Sequence of this application customizer being injected. Use when you have a specific sequence with which to have multiple application customizers being added to the page. Omit to not update this property. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: Int +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Title +The title of the application customizer. Omit to not update this property. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Web +This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: WebPipeBind +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAuditing.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAuditing.md index f5af68a891..28ee07ace9 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAuditing.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAuditing.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Set Auditing setting for a site -## SYNTAX +## SYNTAX ### Specific flags ```powershell @@ -230,4 +230,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAvailablePageLayouts.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAvailablePageLayouts.md index 7a45332366..76161f8df6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAvailablePageLayouts.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPAvailablePageLayouts.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets the available page layouts for the current site -## SYNTAX +## SYNTAX ### SPECIFIC ```powershell @@ -97,4 +97,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSidePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSidePage.md index c74861030e..0228fe6618 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSidePage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSidePage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets parameters of a Client-Side Page -## SYNTAX +## SYNTAX ### Custom Header ```powershell @@ -26,6 +26,7 @@ Set-PnPClientSidePage -Identity [-Publish []] [-HeaderType ] [-ContentType ] + [-ThumbnailUrl ] [-Web ] [-Connection ] ``` @@ -202,6 +203,20 @@ Position: 0 Accept pipeline input: False ``` +### -ThumbnailUrl +Thumbnail Url + +Only applicable to: SharePoint Online, SharePoint Server 2019 + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -Title Sets the title of the page. @@ -274,4 +289,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideText.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideText.md index d2056704ba..cfa49f2c38 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideText.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideText.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Set Client-Side Text Component properties -## SYNTAX +## SYNTAX ```powershell Set-PnPClientSideText -Page @@ -106,4 +106,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideWebPart.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideWebPart.md index ddc3f3b718..e26c748788 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideWebPart.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPClientSideWebPart.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Set Client-Side Web Part properties -## SYNTAX +## SYNTAX ```powershell Set-PnPClientSideWebPart -Page @@ -121,4 +121,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPContext.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPContext.md index 94b66608f4..286b3942ec 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPContext.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPContext.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Set the ClientContext -## SYNTAX +## SYNTAX ```powershell Set-PnPContext -Context @@ -50,4 +50,4 @@ Accept pipeline input: True ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultColumnValues.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultColumnValues.md index b25ded858a..92068fc8b7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultColumnValues.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultColumnValues.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets default column values for a document library -## SYNTAX +## SYNTAX ```powershell Set-PnPDefaultColumnValues -List @@ -147,4 +147,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultContentTypeToList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultContentTypeToList.md index 8120146c84..51dafbe6c7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultContentTypeToList.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultContentTypeToList.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets the default content type for a list -## SYNTAX +## SYNTAX ```powershell Set-PnPDefaultContentTypeToList -List @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultPageLayout.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultPageLayout.md index d812363180..fd9ee33d24 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultPageLayout.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDefaultPageLayout.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets a specific page layout to be the default page layout for a publishing site -## SYNTAX +## SYNTAX ### TITLE ```powershell @@ -101,4 +101,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDocumentSetField.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDocumentSetField.md index f795e8f158..3d29e82767 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDocumentSetField.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPDocumentSetField.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets a site column from the available content types to a document set -## SYNTAX +## SYNTAX ```powershell Set-PnPDocumentSetField -DocumentSet @@ -139,4 +139,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPField.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPField.md index d139fd1ecb..c945f4c299 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPField.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPField.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Changes one or more properties of a field in a specific list or for the whole web -## SYNTAX +## SYNTAX ```powershell Set-PnPField -Identity @@ -124,4 +124,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedIn.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedIn.md index 83cae7500a..1b9eee1182 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedIn.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedIn.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Checks in a file -## SYNTAX +## SYNTAX ```powershell Set-PnPFileCheckedIn -Url @@ -113,4 +113,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedOut.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedOut.md index 7c8db9d063..e728ba5ca3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedOut.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFileCheckedOut.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Checks out a file -## SYNTAX +## SYNTAX ```powershell Set-PnPFileCheckedOut -Url @@ -67,4 +67,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFolderPermission.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFolderPermission.md new file mode 100644 index 0000000000..deda0f25ad --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPFolderPermission.md @@ -0,0 +1,219 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/set-pnpfolderpermission +applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +schema: 2.0.0 +--- + +# Set-PnPFolderPermission + +## SYNOPSIS +Sets folder permissions. Use Get-PnPRoleDefinition to retrieve all available roles you can add or remove using this cmdlet. + +## SYNTAX + +### Inherit +```powershell +Set-PnPFolderPermission -List + -Identity + [-InheritPermissions []] + [-SystemUpdate []] + [-Web ] + [-Connection ] +``` + +### Group +```powershell +Set-PnPFolderPermission -Group + -List + -Identity + [-AddRole ] + [-RemoveRole ] + [-ClearExisting []] + [-SystemUpdate []] + [-Web ] + [-Connection ] +``` + +### User +```powershell +Set-PnPFolderPermission -User + -List + -Identity + [-AddRole ] + [-RemoveRole ] + [-ClearExisting []] + [-SystemUpdate []] + [-Web ] + [-Connection ] +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Set-PnPFolderPermission -List 'Shared Documents' -Identity 'Shared Documents\Folder' -User 'user@contoso.com' -AddRole 'Contribute' +``` + +Adds the 'Contribute' permission to the user 'user@contoso.com' for the folder named 'Folder' located in the root of the library 'Shared Documents' + +### ------------------EXAMPLE 2------------------ +```powershell +Set-PnPFolderPermission -List 'Documents' -Identity 'Shared Documents\Folder\Subfolder' -User 'user@contoso.com' -RemoveRole 'Contribute' +``` + +Removes the 'Contribute' permission to the user 'user@contoso.com' for the folder named 'Subfolder' located in the folder 'Folder' which is located in the root of the library 'Shared Documents' + +### ------------------EXAMPLE 3------------------ +```powershell +Set-PnPFolderPermission -List 'Documents' -Identity 'Shared Documents\Folder' -User 'user@contoso.com' -AddRole 'Contribute' -ClearExisting +``` + +Adds the 'Contribute' permission to the user 'user@contoso.com' for the folder named 'Folder' located in the root of the library 'Shared Documents' and removes all other permissions + +### ------------------EXAMPLE 4------------------ +```powershell +Get-PnPFolder -Url 'Shared Documents\Folder' | Set-PnPFolderPermission -List 'Documents' -InheritPermissions +``` + +Resets permissions for the folder named 'Folder' located in the root of the library 'Shared Documents' to inherit permissions from the library 'Shared Documents' + +## PARAMETERS + +### -AddRole +The role that must be assigned to the group or user + +```yaml +Type: String +Parameter Sets: User, Group + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -ClearExisting +Clear all existing permissions + +```yaml +Type: SwitchParameter +Parameter Sets: User, Group + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Group + + +```yaml +Type: GroupPipeBind +Parameter Sets: Group + +Required: True +Position: Named +Accept pipeline input: False +``` + +### -Identity +The ID of the folder, the server relative URL to the folder or actual Folder object + +```yaml +Type: FolderPipeBind +Parameter Sets: __AllParameterSets + +Required: True +Position: Named +Accept pipeline input: True +``` + +### -InheritPermissions +Inherit permissions from the parent, removing unique permissions + +```yaml +Type: SwitchParameter +Parameter Sets: Inherit + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -List +The ID, Title or Url of the list the folder is part of + +```yaml +Type: ListPipeBind +Parameter Sets: __AllParameterSets + +Required: True +Position: 0 +Accept pipeline input: False +``` + +### -RemoveRole +The role that must be removed from the group or user + +```yaml +Type: String +Parameter Sets: User, Group + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -SystemUpdate +Update the folder permissions without creating a new version or triggering MS Flow. + +Only applicable to: SharePoint Online + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -User + + +```yaml +Type: String +Parameter Sets: User + +Required: True +Position: Named +Accept pipeline input: False +``` + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Web +This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. + +```yaml +Type: WebPipeBind +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroup.md index c469ec191a..1d83338783 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroup.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroup.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Updates a group -## SYNTAX +## SYNTAX ```powershell Set-PnPGroup -Identity @@ -217,4 +217,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroupPermissions.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroupPermissions.md index 970b8e228f..f44bf3c939 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroupPermissions.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPGroupPermissions.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Adds and/or removes permissions of a specific SharePoint group -## SYNTAX +## SYNTAX ### ByName ```powershell @@ -136,4 +136,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHideDefaultThemes.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHideDefaultThemes.md index fdad4c7002..ae8b12c7a8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHideDefaultThemes.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHideDefaultThemes.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Defines if the default / OOTB themes should be visible to users or not. -## SYNTAX +## SYNTAX ```powershell Set-PnPHideDefaultThemes -HideDefaultThemes @@ -66,4 +66,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHomePage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHomePage.md index 3764b261c9..daf3fafac1 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHomePage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHomePage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets the home page of the current web. -## SYNTAX +## SYNTAX ```powershell Set-PnPHomePage -RootFolderRelativeUrl @@ -68,4 +68,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHomeSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHomeSite.md index 61ac742b20..57970cfd7a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHomeSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHomeSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets the home site for your tenant -## SYNTAX +## SYNTAX ```powershell Set-PnPHomeSite -Url @@ -54,4 +54,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHubSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHubSite.md index 7a83772575..c964e965db 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHubSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPHubSite.md @@ -8,15 +8,20 @@ schema: 2.0.0 # Set-PnPHubSite ## SYNOPSIS -Sets hubsite properties +Sets hub site properties -## SYNTAX +## SYNTAX ```powershell Set-PnPHubSite [-SiteDesignId ] + [-HideNameInNavigation []] + [-RequiresJoinApproval []] [-Connection ] ``` +## DESCRIPTION +Allows configuring a hub site + ## EXAMPLES ### ------------------EXAMPLE 1------------------ @@ -24,12 +29,57 @@ Set-PnPHubSite [-SiteDesignId ] Set-PnPHubSite -Identity https://tenant.sharepoint.com/sites/myhubsite -Title "My New Title" ``` -Sets the title of the hubsite +Sets the title of the hub site + +### ------------------EXAMPLE 2------------------ +```powershell +Set-PnPHubSite -Identity https://tenant.sharepoint.com/sites/myhubsite -Description "My updated description" +``` + +Sets the description of the hub site + +### ------------------EXAMPLE 3------------------ +```powershell +Set-PnPHubSite -Identity https://tenant.sharepoint.com/sites/myhubsite -SiteDesignId df8a3ef1-9603-44c4-abd9-541aea2fa745 +``` + +Sets the site design which should be applied to sites joining the the hub site + +### ------------------EXAMPLE 4------------------ +```powershell +Set-PnPHubSite -Identity https://tenant.sharepoint.com/sites/myhubsite -LogoUrl "https://tenant.sharepoint.com/SiteAssets/Logo.png" +``` + +Sets the logo of the hub site ## PARAMETERS -### -SiteDesignId +### -HideNameInNavigation + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Required: False +Position: Named +Accept pipeline input: False +``` + +### -RequiresJoinApproval + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -SiteDesignId +GUID of the SharePoint Site Design which should be applied when a site joins the hub site ```yaml Type: GuidPipeBind @@ -54,4 +104,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPInPlaceRecordsManagement.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPInPlaceRecordsManagement.md index 4ea5a11755..b7acd6bc93 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPInPlaceRecordsManagement.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPInPlaceRecordsManagement.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Activates or deactivates in the place records management feature. -## SYNTAX +## SYNTAX ### Enable or Disable ```powershell @@ -75,4 +75,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPIndexedProperties.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPIndexedProperties.md index b841ff50ea..09c0389d8a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPIndexedProperties.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPIndexedProperties.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Marks values of the propertybag to be indexed by search. Notice that this will overwrite the existing flags, i.e. only the properties you define with the cmdlet will be indexed. -## SYNTAX +## SYNTAX ```powershell Set-PnPIndexedProperties -Keys @@ -58,4 +58,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPLabel.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPLabel.md index 53de9bf26e..068b62377e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPLabel.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPLabel.md @@ -8,9 +8,9 @@ schema: 2.0.0 # Set-PnPLabel ## SYNOPSIS -Sets a label/tag on the specified list or library +Sets a label/tag on the specified list or library. Use Reset-PnPLabel to remove the label again. -## SYNTAX +## SYNTAX ```powershell Set-PnPLabel -List @@ -29,7 +29,7 @@ Set-PnPLabel -List Set-PnPLabel -List "Demo List" -Label "Project Documentation" ``` -This sets an O365 label on the specified list or library. +This sets an O365 label on the specified list or library. ### ------------------EXAMPLE 2------------------ ```powershell @@ -43,7 +43,7 @@ This sets an O365 label on the specified list or library and sets the label to a Set-PnPLabel -List "Demo List" -Label "Project Documentation" -BlockDelete $true -BlockEdit $true ``` -This sets an O365 label on the specified list or library. Next, it also blocks the ability to either edit or delete the item. +This sets an O365 label on the specified list or library. Next, it also blocks the ability to either edit or delete the item. ## PARAMETERS @@ -133,4 +133,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPList.md index 495b33dfa6..77fddf3c0a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPList.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPList.md @@ -10,12 +10,13 @@ schema: 2.0.0 ## SYNOPSIS Updates list settings -## SYNTAX +## SYNTAX ```powershell Set-PnPList -Identity [-EnableContentTypes ] [-BreakRoleInheritance []] + [-ResetRoleInheritance []] [-CopyRoleAssignments []] [-ClearSubscopes []] [-Title ] @@ -274,6 +275,18 @@ Position: Named Accept pipeline input: False ``` +### -ResetRoleInheritance +If used the security inheritance is reset for this list (inherited from parent) + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -Title The title of the list @@ -312,4 +325,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListInformationRightsManagement.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListInformationRightsManagement.md index 5f4e702274..67e94f50ef 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListInformationRightsManagement.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListInformationRightsManagement.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Get the site closure status of the site which has a site policy applied -## SYNTAX +## SYNTAX ```powershell Set-PnPListInformationRightsManagement -List @@ -301,4 +301,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItem.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItem.md index 9e59001ac1..190a470d5b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItem.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItem.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Updates a list item -## SYNTAX +## SYNTAX ```powershell Set-PnPListItem -List @@ -18,6 +18,7 @@ Set-PnPListItem -List [-ContentType ] [-Values ] [-SystemUpdate []] + [-Label ] [-Web ] [-Connection ] ``` @@ -45,6 +46,13 @@ Set-PnPListItem -List "Demo List" -Identity $item -Values @{"Title" = "Test Titl Sets fields value in the list item which has been retrieved by for instance Get-PnPListItem. It sets the content type of the item to "Company" and it sets both the Title and Category fields with the specified values. Notice, use the internal names of fields. +### ------------------EXAMPLE 4------------------ +```powershell +Set-PnPListItem -List "Demo List" -Identity 1 -Label "Public" +``` + +Sets the retention label in the list item with ID 1 in the "Demo List". + ## PARAMETERS ### -ContentType @@ -71,6 +79,20 @@ Position: Named Accept pipeline input: True ``` +### -Label +The name of the retention label. + +Only applicable to: SharePoint Online + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -List The ID, Title or Url of the list. @@ -177,4 +199,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemAsRecord.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemAsRecord.md index e59f349454..518809571f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemAsRecord.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemAsRecord.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Declares a list item as a record, for more information, see https://docs.microsoft.com/sharepoint/governance/records-management-in-sharepoint-server -## SYNTAX +## SYNTAX ```powershell Set-PnPListItemAsRecord -List @@ -100,4 +100,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemPermission.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemPermission.md index b98fc409c5..16f4adaf12 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemPermission.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListItemPermission.md @@ -8,9 +8,9 @@ schema: 2.0.0 # Set-PnPListItemPermission ## SYNOPSIS -Sets list item permissions +Sets list item permissions. Use Get-PnPRoleDefinition to retrieve all available roles you can add or remove using this cmdlet. -## SYNTAX +## SYNTAX ### Inherit ```powershell @@ -216,4 +216,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListPermission.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListPermission.md index eb677ba07a..c79d90639c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListPermission.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListPermission.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets list permissions -## SYNTAX +## SYNTAX ### Group ```powershell @@ -136,4 +136,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListRecordDeclaration.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListRecordDeclaration.md index e67f9a1952..f709e4ff05 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListRecordDeclaration.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPListRecordDeclaration.md @@ -15,7 +15,7 @@ NeverAllowManualDeclaration UseSiteCollectionDefaults -## SYNTAX +## SYNTAX ```powershell Set-PnPListRecordDeclaration -List @@ -105,4 +105,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMasterPage.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMasterPage.md index 7e51d44eb7..8180b88d76 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMasterPage.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMasterPage.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Set the masterpage -## SYNTAX +## SYNTAX ### Server Relative ```powershell @@ -139,4 +139,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMinimalDownloadStrategy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMinimalDownloadStrategy.md index 34467e6629..0c44e4bac6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMinimalDownloadStrategy.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPMinimalDownloadStrategy.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Activates or deactivates the minimal downloading strategy. -## SYNTAX +## SYNTAX ### On ```powershell @@ -111,4 +111,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPPropertyBagValue.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPPropertyBagValue.md index 6156944cf2..e5e19c4c11 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPPropertyBagValue.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPPropertyBagValue.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets a property bag value -## SYNTAX +## SYNTAX ### Folder ```powershell @@ -96,7 +96,7 @@ Accept pipeline input: False ```yaml Type: String -Parameter Sets: Web, Folder, +Parameter Sets: Web, Folder, Required: True Position: Named @@ -129,4 +129,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPProvisioningTemplateMetadata.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPProvisioningTemplateMetadata.md index 7bca1e108d..8c8d6645f2 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPProvisioningTemplateMetadata.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPProvisioningTemplateMetadata.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets metadata of a provisioning template -## SYNTAX +## SYNTAX ```powershell Set-PnPProvisioningTemplateMetadata -Path @@ -154,4 +154,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPRequestAccessEmails.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPRequestAccessEmails.md index eb1471c99c..0d7cb486b8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPRequestAccessEmails.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPRequestAccessEmails.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets Request Access Emails on a web -## SYNTAX +## SYNTAX ```powershell Set-PnPRequestAccessEmails -Emails @@ -22,7 +22,7 @@ Set-PnPRequestAccessEmails -Emails ### ------------------EXAMPLE 1------------------ ```powershell -Set-PnPRequestAccessEmails -Emails someone@example.com +Set-PnPRequestAccessEmails -Emails someone@example.com ``` This will update the request access e-mail address @@ -74,4 +74,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSearchConfiguration.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSearchConfiguration.md index c59b99dd9c..68dae31fa8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSearchConfiguration.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSearchConfiguration.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets the search configuration -## SYNTAX +## SYNTAX ### Config ```powershell @@ -122,4 +122,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSearchSettings.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSearchSettings.md new file mode 100644 index 0000000000..479ff7a7e3 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSearchSettings.md @@ -0,0 +1,164 @@ +--- +external help file: +online version: https://docs.microsoft.com/powershell/module/sharepoint-pnp/set-pnpsearchsettings +applicable: SharePoint Online +schema: 2.0.0 +--- + +# Set-PnPSearchSettings + +## SYNOPSIS +Sets search settings for a site + +## SYNTAX + +```powershell +Set-PnPSearchSettings [-SearchBoxInNavBar ] + [-SearchPageUrl ] + [-SearchScope ] + [-Scope ] + [-Force []] + [-Web ] + [-Connection ] +``` + +## EXAMPLES + +### ------------------EXAMPLE 1------------------ +```powershell +Set-PnPSearchSettings -SearchBoxInNavBar Hidden -Scope Site +``` + +Hide the suite bar search box on all pages and sites in the site collection + +### ------------------EXAMPLE 2------------------ +```powershell +Set-PnPSearchSettings -SearchBoxInNavBar Hidden -Scope Web +``` + +Hide the suite bar search box on all pages in the current site + +### ------------------EXAMPLE 3------------------ +```powershell +Set-PnPSearchSettings -SearchPageUrl "https://contoso.sharepoint.com/sites/mysearch/SitePages/search.aspx" +``` + +Redirect the suite bar search box in the site to a custom URL + +### ------------------EXAMPLE 4------------------ +```powershell +Set-PnPSearchSettings -SearchPageUrl "" +``` + +Clear the suite bar search box URL and revert to the default behavior + +### ------------------EXAMPLE 5------------------ +```powershell +Set-PnPSearchSettings -SearchPageUrl "https://contoso.sharepoint.com/sites/mysearch/SitePages/search.aspx" -Scope Site +``` + +Redirect classic search to a custom URL + +### ------------------EXAMPLE 6------------------ +```powershell +Set-PnPSearchSettings -SearchScope Tenant +``` + +Set default behavior of the suite bar search box to show tenant wide results instead of site or hub scoped results + +### ------------------EXAMPLE 7------------------ +```powershell +Set-PnPSearchSettings -SearchScope Hub +``` + +Set default behavior of the suite bar search box to show hub results instead of site results on an associated hub site + +## PARAMETERS + +### -Force +Do not ask for confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Scope +Scope to apply the setting to. Possible values: Web (default), Site\r\n\r\nFor a root site, the scope does not matter. + +```yaml +Type: SearchSettingsScope +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -SearchBoxInNavBar +Set the scope of which the suite bar search box shows. Possible values: Inherit, AllPages, ModernOnly, Hidden + +```yaml +Type: SearchBoxInNavBarType +Parameter Sets: __AllParameterSets + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -SearchPageUrl +Set the URL where the search box should redirect to. + +```yaml +Type: String +Parameter Sets: __AllParameterSets + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -SearchScope +Set the search scope of the suite bar search box. Possible values: DefaultScope, Tenant, Hub, Site + +```yaml +Type: SearchScopeType +Parameter Sets: __AllParameterSets + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Connection +Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. + +```yaml +Type: SPOnlineConnection +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -Web +This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web. + +```yaml +Type: WebPipeBind +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + +## RELATED LINKS + +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSite.md index dd25946c82..56b84e590e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets Site Collection properties. -## SYNTAX +## SYNTAX ### Set Properties ```powershell @@ -351,4 +351,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteClosure.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteClosure.md index 1d83310fe0..63b71a20c8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteClosure.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteClosure.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Opens or closes a site which has a site policy applied -## SYNTAX +## SYNTAX ```powershell Set-PnPSiteClosure -State @@ -74,4 +74,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteDesign.md index 9fe758ba90..7df7a63264 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteDesign.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteDesign.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Updates a Site Design on the current tenant. -## SYNTAX +## SYNTAX ```powershell Set-PnPSiteDesign -Identity @@ -166,4 +166,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSitePolicy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSitePolicy.md index cd1433c613..2d12aa7041 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSitePolicy.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSitePolicy.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets a site policy -## SYNTAX +## SYNTAX ```powershell Set-PnPSitePolicy -Name @@ -67,4 +67,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteScript.md index 65e0124a55..f094f2f4f3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteScript.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPSiteScript.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Updates an existing Site Script on the current tenant. -## SYNTAX +## SYNTAX ```powershell Set-PnPSiteScript -Identity @@ -32,7 +32,7 @@ Updates an existing Site Script and changes the title. ### ------------------EXAMPLE 2------------------ ```powershell -$script = Get-PnPSiteScript -Identity f1d55d9b-b116-4f54-bc00-164a51e7e47f +$script = Get-PnPSiteScript -Identity f1d55d9b-b116-4f54-bc00-164a51e7e47f Set-PnPSiteScript -Identity $script -Title "My Site Script" ``` @@ -114,4 +114,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPStorageEntity.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPStorageEntity.md index 81109da9d4..75fc3ee0af 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPStorageEntity.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPStorageEntity.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Set Storage Entities / Farm Properties in either the tenant scoped app catalog or the site collection app catalog. -## SYNTAX +## SYNTAX ```powershell Set-PnPStorageEntity -Key @@ -113,4 +113,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTaxonomyFieldValue.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTaxonomyFieldValue.md index 27360203c9..2a62477068 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTaxonomyFieldValue.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTaxonomyFieldValue.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets a taxonomy term value in a listitem field -## SYNTAX +## SYNTAX ### ITEMS ```powershell @@ -148,4 +148,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenant.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenant.md index 171bb7d533..fe5f1b3f1e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenant.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenant.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets organization-level site collection properties -## SYNTAX +## SYNTAX ```powershell Set-PnPTenant [-MinCompatibilityLevel ] @@ -71,6 +71,7 @@ Set-PnPTenant [-MinCompatibilityLevel ] [-EmailAttestationRequired ] [-EmailAttestationReAuthDays ] [-HideDefaultThemes ] + [-DisabledWebPartIds ] [-Connection ] ``` @@ -219,12 +220,12 @@ Accept pipeline input: False ``` ### -DefaultSharingLinkType -Lets administrators choose what type of link appears is selected in the "Get a link" sharing dialog box in OneDrive for Business and SharePoint Online. +Lets administrators choose what type of link appears is selected in the “Get a link” sharing dialog box in OneDrive for Business and SharePoint Online. For additional information about how to change the default link type, see Change the default link type when users get links for sharing. Note: -Setting this value to "none" will default "get a link" to the most permissive link available (that is, if anonymous links are enabled, the default link will be anonymous access; if they are disabled then the default link will be internal. +Setting this value to “none” will default “get a link” to the most permissive link available (that is, if anonymous links are enabled, the default link will be anonymous access; if they are disabled then the default link will be internal. The values are: None Direct Internal AnonymousAccess @@ -237,6 +238,18 @@ Position: Named Accept pipeline input: False ``` +### -DisabledWebPartIds +Guids of out of the box modern web part id's to hide + +```yaml +Type: Guid[] +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -DisallowInfectedFileDownload Prevents the Download button from being displayed on the Virus Found warning page. @@ -504,7 +517,7 @@ Accept pipeline input: False ``` ### -NotifyOwnersWhenInvitationsAccepted -When this parameter is set to $true and when an external user accepts an invitation to a resource in a user's OneDrive for Business, the OneDrive for Business owner is notified by e-mail. +When this parameter is set to $true and when an external user accepts an invitation to a resource in a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. @@ -520,7 +533,7 @@ Accept pipeline input: False ``` ### -NotifyOwnersWhenItemsReshared -When this parameter is set to $true and another user re-shares a document from a user's OneDrive for Business, the OneDrive for Business owner is notified by e-mail. +When this parameter is set to $true and another user re-shares a document from a user’s OneDrive for Business, the OneDrive for Business owner is notified by e-mail. For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. @@ -795,7 +808,7 @@ The valid values are: ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled. Disabled - External user sharing (share by email) and guest link sharing are both disabled. ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing is disabled. -For more information about sharing, see Manage external sharing for your SharePoint online environment (https://office.microsoft.com/en-us/office365-sharepoint-online-enterprise-help/manage-external-sharing-for-your-sharepoint-online-environment-HA102849864.aspx). +For more information about sharing, see Manage external sharing for your SharePoint online environment (http://office.microsoft.com/en-us/office365-sharepoint-online-enterprise-help/manage-external-sharing-for-your-sharepoint-online-environment-HA102849864.aspx). ```yaml Type: SharingCapabilities @@ -1003,4 +1016,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnEnabled.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnEnabled.md index f9e3916f25..7ef48f5cf3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnEnabled.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnEnabled.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Enables or disabled the public or private Office 365 Content Delivery Network (CDN). -## SYNTAX +## SYNTAX ```powershell Set-PnPTenantCdnEnabled -Enable @@ -70,4 +70,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnPolicy.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnPolicy.md index 825513848a..ba08d1730f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnPolicy.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantCdnPolicy.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets the CDN Policies for the specified CDN (Public | Private). -## SYNTAX +## SYNTAX ```powershell Set-PnPTenantCdnPolicy -CdnType @@ -83,4 +83,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantSite.md index c3ea2cd987..6fa618097e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTenantSite.md @@ -10,22 +10,29 @@ schema: 2.0.0 ## SYNOPSIS Set site information. -## SYNTAX +## SYNTAX ### Set Properties ```powershell Set-PnPTenantSite -Url [-Title ] - [-Sharing ] + [-SharingCapability ] + [-DenyAddAndCustomizePages []] + [-LocaleId ] [-StorageMaximumLevel ] [-StorageWarningLevel ] - [-UserCodeMaximumLevel ] - [-UserCodeWarningLevel ] [-AllowSelfServiceUpgrade []] [-Owners ] - [-NoScriptSite []] [-DefaultLinkPermission ] [-DefaultSharingLinkType ] + [-SharingAllowedDomainList ] + [-SharingBlockedDomainList ] + [-BlockDownloadOfNonViewableFiles []] + [-SharingDomainRestrictionMode ] + [-CommentsOnSitePagesDisabled []] + [-DisableAppViews ] + [-DisableCompanyWideSharingLinks ] + [-DisableFlows ] [-Wait []] [-Connection ] ``` @@ -92,6 +99,30 @@ Position: Named Accept pipeline input: False ``` +### -BlockDownloadOfNonViewableFiles +Specifies if non web viewable files can be downloaded. + +```yaml +Type: SwitchParameter +Parameter Sets: Set Properties + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -CommentsOnSitePagesDisabled +Specifies if comments on site pages are enabled + +```yaml +Type: SwitchParameter +Parameter Sets: Set Properties + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -DefaultLinkPermission Specifies the default link permission for the site collection. None - Respect the organization default link permission. View - Sets the default link permission for the site to "view" permissions. Edit - Sets the default link permission for the site to "edit" permissions @@ -116,6 +147,67 @@ Position: Named Accept pipeline input: False ``` +### -DenyAddAndCustomizePages +Determines whether the Add And Customize Pages right is denied on the site collection. For more information about permission levels, see User permissions and permission levels in SharePoint. + +```yaml +Type: SwitchParameter +Parameter Sets: Set Properties +Aliases: NoScriptSite + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -DisableAppViews +- + +```yaml +Type: AppViewsPolicy +Parameter Sets: Set Properties + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -DisableCompanyWideSharingLinks +- + +```yaml +Type: CompanyWideSharingLinksPolicy +Parameter Sets: Set Properties + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -DisableFlows +- + +```yaml +Type: FlowsPolicy +Parameter Sets: Set Properties + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -LocaleId +Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft (https://go.microsoft.com/fwlink/p/?LinkId=242911). + +```yaml +Type: UInt32 +Parameter Sets: Set Properties + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -LockState Sets the lockstate of a site @@ -128,11 +220,11 @@ Position: Named Accept pipeline input: False ``` -### -NoScriptSite -Specifies if a site allows custom script or not. See https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f for more information. +### -Owners +Specifies owner(s) to add as site collection administrators. They will be added as additional site collection administrators. Existing administrators will stay. Can be both users and groups. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Set Properties Required: False @@ -140,8 +232,20 @@ Position: Named Accept pipeline input: False ``` -### -Owners -Specifies owner(s) to add as site collection administrators. They will be added as additional site collection administrators. Existing administrators will stay. Can be both users and groups. +### -SharingAllowedDomainList +Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". + +```yaml +Type: String +Parameter Sets: Set Properties + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -SharingBlockedDomainList +Specifies a list of email domains that is blocked for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". ```yaml Type: String @@ -152,12 +256,25 @@ Position: Named Accept pipeline input: False ``` -### -Sharing +### -SharingCapability Specifies what the sharing capabilities are for the site. Possible values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly ```yaml Type: SharingCapabilities Parameter Sets: Set Properties +Aliases: Sharing + +Required: False +Position: Named +Accept pipeline input: False +``` + +### -SharingDomainRestrictionMode +Specifies the external sharing mode for domains. + +```yaml +Type: SharingDomainRestrictionModes +Parameter Sets: Set Properties Required: False Position: Named @@ -212,30 +329,6 @@ Position: 0 Accept pipeline input: True ``` -### -UserCodeMaximumLevel -Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010 : http://msdn.microsoft.com/en-us/library/gg615462.aspx. - -```yaml -Type: Double -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - -### -UserCodeWarningLevel -Specifies the warning level for the resource quota. This value must not exceed the value set for the UserCodeMaximumLevel parameter - -```yaml -Type: Double -Parameter Sets: Set Properties - -Required: False -Position: Named -Accept pipeline input: False -``` - ### -Wait Wait for the operation to complete @@ -262,4 +355,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTheme.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTheme.md index bcf71a43b2..4550a251bb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTheme.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTheme.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets the theme of the current web. -## SYNTAX +## SYNTAX ```powershell Set-PnPTheme [-ColorPaletteUrl ] @@ -143,4 +143,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTraceLog.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTraceLog.md index 657da16328..573b85544b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTraceLog.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPTraceLog.md @@ -10,12 +10,13 @@ schema: 2.0.0 ## SYNOPSIS Turn log tracing on or off -## SYNTAX +## SYNTAX ### On ```powershell Set-PnPTraceLog -On [] [-LogFile ] + [-WriteToConsole []] [-Level ] [-Delimiter ] [-IndentSize ] @@ -146,6 +147,18 @@ Position: Named Accept pipeline input: False ``` +### -WriteToConsole +Turn on console trace output. + +```yaml +Type: SwitchParameter +Parameter Sets: On + +Required: False +Position: Named +Accept pipeline input: False +``` + ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUnifiedGroup.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUnifiedGroup.md index 4c75a163ec..da4b1fd030 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUnifiedGroup.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUnifiedGroup.md @@ -8,9 +8,9 @@ schema: 2.0.0 # Set-PnPUnifiedGroup ## SYNOPSIS -Sets Office 365 Group (aka Unified Group) properties +Sets Office 365 Group (aka Unified Group) properties. Requires the Azure Active Directory application permission 'Group.ReadWrite.All'. -## SYNTAX +## SYNTAX ```powershell Set-PnPUnifiedGroup -Identity @@ -160,4 +160,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUserProfileProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUserProfileProperty.md index ca0c28539b..e7767fbcac 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUserProfileProperty.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPUserProfileProperty.md @@ -10,10 +10,10 @@ schema: 2.0.0 ## SYNOPSIS Office365 only: Uses the tenant API to retrieve site information. -You must connect to the tenant admin website (https://:-admin.sharepoint.com) with Connect-PnPOnline in order to use this command. +You must connect to the tenant admin website (https://:-admin.sharepoint.com) with Connect-PnPOnline in order to use this command. -## SYNTAX +## SYNTAX ### Single ```powershell @@ -38,14 +38,14 @@ Requires a connection to a SharePoint Tenant Admin site. ### ------------------EXAMPLE 1------------------ ```powershell -Set-PnPUserProfileProperty -Account 'user@domain.com' -PropertyName 'SPS-Location' -Value 'Stockholm' +Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'SPS-Location' -Value 'Stockholm' ``` Sets the SPS-Location property for the user as specified by the Account parameter ### ------------------EXAMPLE 2------------------ ```powershell -Set-PnPUserProfileProperty -Account 'user@domain.com' -PropertyName 'MyProperty' -Values 'Value 1','Value 2' +Set-PnPUserProfileProperty -Account 'user@domain.com' -Property 'MyProperty' -Values 'Value 1','Value 2' ``` Sets the MyProperty multi value property for the user as specified by the Account parameter @@ -114,4 +114,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPView.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPView.md index 9e454f58d1..8f2c24b772 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPView.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPView.md @@ -10,13 +10,14 @@ schema: 2.0.0 ## SYNOPSIS Change view properties -## SYNTAX +## SYNTAX ```powershell Set-PnPView -Identity [-List ] [-Values ] [-Fields ] + [-Aggregations ] [-Web ] [-Connection ] ``` @@ -47,8 +48,29 @@ Set-PnPView -List "Documents" -Identity "Corporate Documents" -Fields "Title","C Updates the Corporate Documents view on the Documents library to have two fields +### ------------------EXAMPLE 4------------------ +```powershell +Set-PnPView -List "Documents" -Identity "Corporate Documents" -Fields "Title","Created" -Aggregations "" +``` + +Updates the Corporate Documents view on the Documents library and sets the totals (aggregations) to Count on the Title field + ## PARAMETERS +### -Aggregations +A valid XML fragment containing one or more Aggregations + +Only applicable to: SharePoint Online + +```yaml +Type: String +Parameter Sets: (All) + +Required: False +Position: Named +Accept pipeline input: False +``` + ### -Fields An array of fields to use in the view. Notice that specifying this value will remove the existing fields @@ -127,4 +149,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWeb.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWeb.md index 37d560c83e..eeed73e183 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWeb.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWeb.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets properties on a web -## SYNTAX +## SYNTAX ```powershell Set-PnPWeb [-SiteLogoUrl ] @@ -107,7 +107,7 @@ Accept pipeline input: False ``` ### -SiteLogoUrl -Sets the logo of the web to the current url. If you want to set the logo to a modern team site, use Set-PnPSite -SiteLogoPath +Sets the logo of the web to the current url. If you want to set the logo to a modern team site, use Set-PnPSite -LogoFilePath. ```yaml Type: String @@ -156,4 +156,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPartProperty.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPartProperty.md index 04d3d10af2..e7f13351f7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPartProperty.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPartProperty.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets a web part property -## SYNTAX +## SYNTAX ```powershell Set-PnPWebPartProperty -ServerRelativePageUrl @@ -25,7 +25,7 @@ Set-PnPWebPartProperty -ServerRelativePageUrl ### ------------------EXAMPLE 1------------------ ```powershell -Set-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914 -Key "Title" -Value "New Title" +Set-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914 -Key "Title" -Value "New Title" ``` Sets the title property of the web part. @@ -107,4 +107,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPermission.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPermission.md index c45c5fce3b..4ccda506cf 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPermission.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebPermission.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Set permissions -## SYNTAX +## SYNTAX ### Group ```powershell @@ -189,4 +189,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebTheme.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebTheme.md index 4314ca28e0..dd59c9a7cc 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebTheme.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebTheme.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets the theme of the current web. -## SYNTAX +## SYNTAX ```powershell Set-PnPWebTheme [-Theme ] @@ -90,4 +90,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebhookSubscription.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebhookSubscription.md index e5012bfed4..97fb5c7ba3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebhookSubscription.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWebhookSubscription.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Updates a Webhook subscription -## SYNTAX +## SYNTAX ```powershell Set-PnPWebhookSubscription -Subscription @@ -128,4 +128,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWikiPageContent.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWikiPageContent.md index af245f372c..ea36a85bee 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWikiPageContent.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Set-PnPWikiPageContent.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Sets the contents of a wikipage -## SYNTAX +## SYNTAX ### STRING ```powershell @@ -93,4 +93,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Start-PnPWorkflowInstance.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Start-PnPWorkflowInstance.md index 624deee597..a49d81a1f5 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Start-PnPWorkflowInstance.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Start-PnPWorkflowInstance.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Starts a workflow instance on a list item -## SYNTAX +## SYNTAX ```powershell Start-PnPWorkflowInstance -Subscription @@ -23,14 +23,14 @@ Start-PnPWorkflowInstance -Subscription ### ------------------EXAMPLE 1------------------ ```powershell -Start-PnPWorkflowInstance -Name 'WorkflowName' -ListItem $item +Start-PnPWorkflowInstance -Name 'WorkflowName' -ListItem $item ``` Starts a workflow instance on the specified list item ### ------------------EXAMPLE 2------------------ ```powershell -Start-PnPWorkflowInstance -Name 'WorkflowName' -ListItem 2 +Start-PnPWorkflowInstance -Name 'WorkflowName' -ListItem 2 ``` Starts a workflow instance on the specified list item @@ -87,4 +87,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Stop-PnPWorkflowInstance.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Stop-PnPWorkflowInstance.md index 792190ec83..866cb3b347 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Stop-PnPWorkflowInstance.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Stop-PnPWorkflowInstance.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Stops a workflow instance -## SYNTAX +## SYNTAX ```powershell Stop-PnPWorkflowInstance -Identity @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Submit-PnPSearchQuery.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Submit-PnPSearchQuery.md index 7aa946c3d3..f85b3c7ca7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Submit-PnPSearchQuery.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Submit-PnPSearchQuery.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Executes an arbitrary search query against the SharePoint search index -## SYNTAX +## SYNTAX ### Limit ```powershell @@ -186,7 +186,7 @@ Accept pipeline input: False ``` ### -HiddenConstraints -The keyword query's hidden constraints. +The keyword query’s hidden constraints. ```yaml Type: String @@ -419,4 +419,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Sync-PnPAppToTeams.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Sync-PnPAppToTeams.md index 031220a1e4..a4edfe3e7a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Sync-PnPAppToTeams.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Sync-PnPAppToTeams.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Synchronize an app from the tenant app catalog to the Microsoft Teams app catalog -## SYNTAX +## SYNTAX ```powershell Sync-PnPAppToTeams -Identity @@ -54,4 +54,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPListItemIsRecord.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPListItemIsRecord.md index d565aef5c2..967f583ab2 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPListItemIsRecord.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPListItemIsRecord.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Checks if a list item is a record -## SYNTAX +## SYNTAX ```powershell Test-PnPListItemIsRecord -List @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPOffice365GroupAliasIsUsed.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPOffice365GroupAliasIsUsed.md index 72afddb563..38580b0e91 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPOffice365GroupAliasIsUsed.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPOffice365GroupAliasIsUsed.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Tests if a given alias is already used used -## SYNTAX +## SYNTAX ```powershell Test-PnPOffice365GroupAliasIsUsed -Alias @@ -57,4 +57,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPTenantTemplate.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPTenantTemplate.md index 1fbd8c236e..bce30437c0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPTenantTemplate.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Test-PnPTenantTemplate.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Tests a tenant template for invalid references -## SYNTAX +## SYNTAX ```powershell Test-PnPTenantTemplate -Template @@ -36,7 +36,6 @@ Only applicable to: SharePoint Online ```yaml Type: ProvisioningHierarchy Parameter Sets: __AllParameterSets -Aliases: Hierarchy Required: True Position: Named @@ -59,4 +58,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPApp.md index 380da32e0f..88a68621c0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPApp.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPApp.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Uninstalls an available add-in from the site -## SYNTAX +## SYNTAX ```powershell Uninstall-PnPApp -Identity @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPAppInstance.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPAppInstance.md index 3ee36e4bba..44267f36ea 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPAppInstance.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPAppInstance.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Removes an app from a site -## SYNTAX +## SYNTAX ```powershell Uninstall-PnPAppInstance -Identity @@ -97,4 +97,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPSolution.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPSolution.md index 2ce20c1e1b..6ea331943f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPSolution.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Uninstall-PnPSolution.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Uninstalls a sandboxed solution from a site collection -## SYNTAX +## SYNTAX ```powershell Uninstall-PnPSolution -PackageId @@ -93,4 +93,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Unpublish-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Unpublish-PnPApp.md index 1a81c0de4e..f62f7b437d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Unpublish-PnPApp.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Unpublish-PnPApp.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Unpublishes/retracts an available add-in from the app catalog -## SYNTAX +## SYNTAX ```powershell Unpublish-PnPApp -Identity @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Unregister-PnPHubSite.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Unregister-PnPHubSite.md index 3d3833be85..340e61e56b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Unregister-PnPHubSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Unregister-PnPHubSite.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Unregisters a site as a hubsite -## SYNTAX +## SYNTAX ```powershell Unregister-PnPHubSite -Site @@ -57,4 +57,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPApp.md index 3bcbc62767..f0c9c76c77 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPApp.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPApp.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Updates an available app from the app catalog -## SYNTAX +## SYNTAX ```powershell Update-PnPApp -Identity @@ -80,4 +80,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPSiteClassification.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPSiteClassification.md index 9dff56870e..bf71d9bc86 100644 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPSiteClassification.md +++ b/sharepoint/sharepoint-ps/sharepoint-pnp/Update-PnPSiteClassification.md @@ -10,7 +10,7 @@ schema: 2.0.0 ## SYNOPSIS Updates Site Classifications for the tenant. Requires a connection to the Microsoft Graph. -## SYNTAX +## SYNTAX ### Specific ```powershell @@ -102,4 +102,4 @@ Accept pipeline input: False ## RELATED LINKS -[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) +[SharePoint Developer Patterns and Practices](https://aka.ms/sppnp) \ No newline at end of file