Merge pull request #1612 from pnp/dev

Intermediate master branch update for documentation reasons

Author: erwinvanhunen

CHANGELOG.md

@@ -7,6 +7,80 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 ## [Current Nightly]
 
+### Added
+
+- Added additional properties to the users returned by `Get-PnPMicrosoft365GroupMember` such as `userType` [#1474](https://github.com/pnp/powershell/pull/1474)
+- Added `Update-PnPTeamsUser` cmdlet to change the role of a user in an existing Teams team [#1499](https://github.com/pnp/powershell/pull/1499)
+- Added `Get\New\Remove\Set-PnPMicrosoft365GroupSettings` cmdlets to interact with Microsoft 365 Group settings.
+- Added `Get-PnPMicrosoft365GroupSettingTemplates` cmdlet to retrieve system wide Microsoft 365 Group setting templates.
+- Added `Add\Remove\Invoke\Get-PnPListDesign` cmdlets to add a list design, remove a list design and apply the list design.
+- Added `DisablePersonalListCreation` parameter to `Set-PnPTenant` cmdlet to provide ability to disable personal lists creation [#1545](https://github.com/pnp/powershell/pull/1545)
+- Added `DisabledModernListTemplateIds` and `EnableModernListTemplateIds` parameters to `Set-PnPTenant` cmdlet to provide ability to disable or enable modern lists with specific Ids [#1545](https://github.com/pnp/powershell/pull/1545)
+- Added `DisablePersonalListCreation` and `DisabledModernListTemplateIds` values to be displayed when using `Get-PnPTenant` cmdlet [#1545](https://github.com/pnp/powershell/pull/1545)
+- Added `Add\Remove\Set-PnPAdaptiveScopeProperty` cmdlets to add/update/remove a property bag value while dealing with the noscript toggling in one cmdlet [#1556](https://github.com/pnp/powershell/pull/1556)
+- Added support to add multiple owners and members in `New-PnPTeamsTeam` cmdlet [#1241](https://github.com/pnp/powershell/pull/1241)
+- Added the ability to set the title of a new modern page in SharePoint Online using `Add-PnPPage` to be different from its filename by using `-Title`
+- Added optional `-UseBeta` parameter to `Get-PnPAzureADUser` to force it to use the Microsoft Graph beta endpoint. This can be necessary when i.e. using `-Select "PreferredDataLocation"` to query for users with a specific multi geo location as this property is only available through the beta endpoint. [#1559](https://github.com/pnp/powershell/pull/1559)
+- Added `-Content` option to `Add-PnPFile` which allows creating a new file on SharePoint Online and directly providing its textual content, i.e. to upload a log file of the execution [#1559](https://github.com/pnp/powershell/pull/1559)
+- Added `Get-PnPTeamsPrimaryChannel` to get the primary Teams channel, general, of a Team [#1572](https://github.com/pnp/powershell/pull/1572)
+- Added `Publish\Unpublish-PnPContentType` to allow for content types to be published or unpublished on hub sites [#1597](https://github.com/pnp/powershell/pull/1597)
+- Added `Get-PnPContentTypePublishingStatus` to get te current publication state of a content type in the content type hub site [#1597](https://github.com/pnp/powershell/pull/1597)
+- Added ability to pipe the output of `Get-PnPTenantDeletedSite` to either `Restore-PnPTenantDeletedSite` or `Remove-PnPTenantDeletedSite` [#1596](https://github.com/pnp/powershell/pull/1596)
+- Added `Rename-PnPTenantSite` to rename a SharePoint Online site URL [#1606](https://github.com/pnp/powershell/pull/1606)
+
+### Changed
+
+- Improved `Add-PnPTeamsUser` cmdlet. The cmdlet executes faster and we can now add users in batches of 200. [#1548](https://github.com/pnp/powershell/pull/1548)
+- The `Move\Remove\Rename-PnPFolder` cmdlets now support pipebinds.
+- Changed `Add-PnPDataRowsToSiteTemplate`, it will return a warning if user(s) are not found during list item extraction. Earlier it used to throw error and stop extraction of list items.
+- Changed the return type of `Sync-PnPSharePointUserProfilesFromAzureActiveDirectory` to return our own entity instead of the one returned by CSOM [#1559](https://github.com/pnp/powershell/pull/1559)
+- Changed running `Sync-PnPSharePointUserProfilesFromAzureActiveDirectory` with `-WhatIf` to also provide a return entity providing the path to where the JSON file has been uploaded to [#1559](https://github.com/pnp/powershell/pull/1559)
+- Disabling telemetry collection now requires either setting the environment variable or creating the telemetry file ([documentation](https://pnp.github.io/powershell/articles/configuration.html)) [#1504](https://github.com/pnp/powershell/pull/1504)
+- Changed `Get-PnPAzureADUser` to now return all the users in Azure Active Directory by default, instead of only the first 999, unless you specified `-EndIndex:$null` [#1565](https://github.com/pnp/powershell/pull/1565)
+- Changed `Get-PnPTenantDeletedSite -Identity` no longer returning an unknown exception when no site collection with the provided Url exists in the tenant recycle bin but instead returning no output to align with other cmdlets [#1596](https://github.com/pnp/powershell/pull/1596)
+
+### Fixed
+
+- Fixed `Set-PnPSite` not working with `DisableCompanyWideSharingLinks` parameter.
+- Fixed `Get-PnPListPermissions` returning wrong information in case of broken inheritance.
+- Fixed `Submit-PnPSearchQuery -Query "somequery"` yielding an error when no results [#1520](https://github.com/pnp/powershell/pull/1520)
+- Fixed `Set-PnPTenantSite` not setting SharingCapability property correctly.
+- Fixed `Get-PnPMicrosoft365Group` retrieving non-Unified groups when parameters are not specified.
+- Fixed `Get-PnPRecycleBinListItem` not retrieving second stage items if only `RowLimit` is specified.
+- Fixed `Add-PnPDataRowsToSiteTemplate` issue with PnP templates when it contained multilingual references.
+- Fixed `Copy-PnPItemProxy` is not recognized as the name of a cmdlet, function, script file, or operable program error with the cmdlet.
+- Fixed `Add-PnPMicrosoft365GroupMember`, `Remove-PnPMicrosoft365GroupMember`, `Add-PnPTeamsUser` and `Remove-PnPTeamsUser` not being able to handle guest accounts containing # characters [#1523](https://github.com/pnp/powershell/pull/1523)
+- Fixed not being able to pipe `Get-PnPHubSite` to `Get-PnPHubSiteChild` to retrieve all site collections which are associated to any hub site [#1571](https://github.com/pnp/powershell/pull/1571)
+- Fixed `Add-PnPFileToSiteTemplate` when used alongside `Get-PnPFile` where the FileStream tried to overwrite an already open filestream when a file was located in the same directory as the template file itself.
+- Fixed `Get-PnPMessageCenterAnnouncement` returning an error [#1607](https://github.com/pnp/powershell/pull/1607)
+- Fixed `New-PnPTeamsTeam` issue when adding Owners and Members.
+- Fixed running an admin cmdlet not always returning to the same context as before running the cmdlet [#1611](https://github.com/pnp/powershell/pull/1611)
+
+### Removed
+
+- Removed `Add-PnPClientSidePageSection`, use `Add-PnPPageSection` instead [#1563](https://github.com/pnp/powershell/pull/1563)
+- Removed `Add-PnPClientSideWebPart`, use `Add-PnPPageWebPart` instead [#1563](https://github.com/pnp/powershell/pull/1563)
+- Removed `Add-PnPClientSideText`, use `Add-PnPPageTextPart` instead [#1563](https://github.com/pnp/powershell/pull/1563)
+- Removed `Get-PnPAADUser`, use `Get-PnPAzureADUser` instead [#1568](https://github.com/pnp/powershell/pull/1568)
+- Removed `Get-PnPOffice365CurrentServiceStatus`, `Get-PnPOffice365HistoricalServiceStatus`, `Get-PnPOffice365ServiceMessage` and `Get-PnPOffice365Services` as Microsoft has removed the underlying Office Management APIs. Use `Get-PnPMessageCenterAnnouncent`, `Get-PnPServiceCurrentHealth` and `Get-PnPServiceHealthIssue` instead. [#1608](https://github.com/pnp/powershell/pull/1608)
+
+### Contributors
+
+- Swapnil Shrivastava [swapnil1993]
+- Hugo Bernier [hugoabernier]
+- brenle
+- Johan Brännmar [brannmar]
+- Lschockaert
+- Leon Armston [LeonArmston]
+- Reshmee Auckloo [reshmee011]
+- Arleta [PowershellScripts]
+- Brendon Lee [brenle]
+- Guillaume Bordier [gbordier]
+- [reusto]
+- Reshmee Auckloo [reshmee011]
+- Gautam Sheth [gautamdsheth]
+- Koen Zomers [koenzomers]
+
 ## [1.9.0]
 
 ### Added
@@ -45,6 +119,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Added `-IsFluidEnabled` to `Set-PnPTenant` cmdlet to enable/disable users from using Fluid components.
 - Added `Add\Get\Remove-PnPListItemComment` cmdlets to deal with list item comments. Using these cmdlets, you will now be able to add, retrieve and delete list item comments. [#1462](https://github.com/pnp/powershell/pull/1462)
 - Added `-ResourceTypeName` and `-ResourceUrl` parameters to `Get-PnPAccessToken` to fetch access token of specified resource. [#1451](https://github.com/pnp/powershell/pull/1451)
+- Added `-BookmarkStatus` parameter to `Get-PnPSearchConfiguration` cmdlet to call REST endpoint to fetch promoted results defined via query rules and output them in Bookmark supported CSV format.
 
 ### Changed
 - Improved `Get-PnPFile` cmdlet to handle large file downloads
@@ -82,6 +157,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Removed `Get-PnPSubWebs` as that was marked deprecated a year ago. Use `Get-PnPSubWeb` instead. [#1394](https://github.com/pnp/powershell/pull/1394)
 
 ### Contributors
+- Mikael Svenson [wobba]
 - Koen Zomers [koenzomers]
 - Bert Jansen [jansenbe]
 - Gautam Sheth [gautamdsheth]

README.md

@@ -1,12 +1,12 @@
 # PnP PowerShell
 
-**PnP PowerShell** is a .NET Core 3.1 / .NET Framework 4.6.1 based PowerShell Module providing over 500 cmdlets that work with Microsoft 365 environments and more specifically SharePoint Online and Microsoft Teams.
+**PnP PowerShell** is a .NET Core 3.1 / .NET Framework 4.6.1 based PowerShell Module providing over 600 cmdlets that work with Microsoft 365 environments and more specifically SharePoint Online and Microsoft Teams.
 
 Last version | Last nightly version
 -------------|---------------------
 [![PnP.PowerShell](https://img.shields.io/powershellgallery/v/pnp.powershell)](https://www.powershellgallery.com/packages/PnP.PowerShell/) | [![PnP.PowerShell](https://img.shields.io/powershellgallery/v/pnp.powershell?include_prereleases)](https://www.powershellgallery.com/packages/PnP.PowerShell/)
 
-This module is a successor of the [PnP-PowerShell](https://github.com/pnp/pnp-powershell) module. The original cmdlets only work on Windows and Windows PowerShell and supports SharePoint On-Premises (2013, 2016 and 2019) and SharePoint Online. This version of the cmdlets is cross-platform (e.g. it works on Windows, MacOS and Linux) however will only support SharePoint Online. Going forward we will only be **actively maintaining the cross-platform PnP PowerShell** module.
+This module is a successor of the [PnP-PowerShell](https://github.com/pnp/pnp-powershell) module. The original cmdlets only work on Windows and Windows PowerShell and supports SharePoint On-Premises (2013, 2016 and 2019) and SharePoint Online. This version of the cmdlets is cross-platform (i.e it works on Windows, MacOS and Linux) but it will only support SharePoint Online. Going forward we will only be **actively maintaining the cross-platform PnP PowerShell** module.
 
 For more information about installing or upgrading to this module, please refer to the documentation at https://pnp.github.io/powershell/articles/index.html
 

build/Build-Nightly.ps1

@@ -51,7 +51,7 @@ if($runPublic -eq $false -and $existing_pnpcoresdk_hash -ne $pnpcoresdk_hash)
 
 if ($runPublish -eq $true) {
 
-	$versionFileContents = Get-Content "$PSScriptRoot/../version.txt" -Raw
+	$versionFileContents = (Get-Content "$PSScriptRoot/../version.txt" -Raw).Trim()
 	if ($versionFileContents.Contains("%")) {
 		$versionString = $versionFileContents.Replace("%", "0");
 		$versionObject = [System.Management.Automation.SemanticVersion]::Parse($versionString)

documentation/Add-PnPField.md

@@ -17,7 +17,7 @@ Add a field
 ### Add field to list (Default)
 ```powershell
 Add-PnPField [-List <ListPipeBind>] -DisplayName <String> -InternalName <String> -Type <FieldType>
- [-Id <Guid>] [-AddToDefaultView] [-Required] [-Group <String>] [-ClientSideComponentId <Guid>]
+ [-Id <Guid>] [-Formula <String>] [-Choices <String>] [-AddToDefaultView] [-Required] [-Group <String>] [-ClientSideComponentId <Guid>]
  [-ClientSideComponentProperties <String>] [-AddToAllContentTypes] [-Connection <PnPConnection>]
  [<CommonParameters>]
 ```
@@ -30,17 +30,11 @@ Add-PnPField -List <ListPipeBind> -Field <FieldPipeBind> [-Connection <PnPConnec
 
 ### Add field to web
 ```powershell
-Add-PnPField -DisplayName <String> -InternalName <String> -Type <FieldType> [-Id <Guid>]
+Add-PnPField -DisplayName <String> -InternalName <String> -Type <FieldType> [-Id <Guid>] [-Formula <String>] [-Choices <String>]
  [-ClientSideComponentId <Guid>] [-ClientSideComponentProperties <String>] 
  [-Connection <PnPConnection>] [<CommonParameters>]
 ```
 
-### Add field by XML to list
-```powershell
-Add-PnPField [-AddToDefaultView] [-Required] [-Group <String>] [-AddToAllContentTypes]
- [-Connection <PnPConnection>] [<CommonParameters>]
-```
-
 ## DESCRIPTION
 Adds a field (a column) to a list or as a site column. To add a column of type Managed Metadata use the Add-PnPTaxonomyField cmdlet.
 
@@ -67,14 +61,28 @@ Add-PnPField -List "Demo list" -DisplayName "Speakers" -InternalName "SPSSpeaker
 
 This will add a field of type Multiple Choice to the list "Demo List". (you can pick several choices for the same item)
 
+### EXAMPLE 4
+```powershell
+Add-PnPField -List "Demo List" -Field "MyTestCol"
+```
+
+This will add an existing site column called "MyTestCol" to the list "Demo List".
+
+### EXAMPLE 5
+```powershell
+Add-PnPField -Type Choice -Choices "PnP","Parker","Sharing Is Caring" -DisplayName "My Test Column" -InternalName "MyTestCol"
+```
+
+This will add a site column of type Choice (only one choice value can be chosen at the same time) called "My Test Column" with three choice values.
+
 ## PARAMETERS
 
 ### -AddToDefaultView
 Switch Parameter if this field must be added to the default view
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: Add field to list, Add field by XML to list
+Parameter Sets: Add field to list, Add field to web
 
 Required: False
 Position: Named
@@ -88,7 +96,20 @@ Switch Parameter if this field must be added to all content types
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: Add field to list, Add field by XML to list
+Parameter Sets: Add field to list, Add field to web
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+### -Choices
+The Choice values when field type is Choice or MultiChoice
+
+```yaml
+Type: String[]
+Parameter Sets: Add field to list (Choice or MultiChoice Field Chosen), Add field to web (Choice or MultiChoice Field Chosen)
 
 Required: False
 Position: Named
@@ -167,6 +188,20 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -Formula
+The Formula when Calculated column is chosen.
+
+```yaml
+Type: String[]
+Parameter Sets: Add field to list (Calculated Field), Add field to web  (Calculated Field)
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Group
 The group name to where this field belongs to
 
@@ -239,7 +274,7 @@ Switch Parameter if the field is a required field
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: Add field to list, Add field by XML to list
+Parameter Sets: Add field to list, Add field to web
 
 Required: False
 Position: Named

documentation/Add-PnPFileToSiteTemplate.md

@@ -10,7 +10,11 @@ title: Add-PnPFileToSiteTemplate
 # Add-PnPFileToSiteTemplate
 
 ## SYNOPSIS
-Adds a file to a PnP Provisioning Template
+Adds a file to a PnP Provisioning Template package
+
+## Description
+
+Allows adding a file to a PnP Provisioning Template package (.pnp) so that the file will get uploaded to the SharePoint Online site to which the template is being invoked. This allows the file to be referenced in i.e. a document template, site logo or any other component that references a file.
 
 ## SYNTAX
 
@@ -35,17 +39,17 @@ Add-PnPFileToSiteTemplate [-Path] <String> [-SourceUrl] <String> [[-Container] <
 
 ### EXAMPLE 1
 ```powershell
-Add-PnPFileToSiteTemplate -Path template.pnp -Source $sourceFilePath -Folder $targetFolder
+Add-PnPFileToSiteTemplate -Path template.pnp -Source "Instructions.docx" -Folder "Shared Documents"
 ```
 
-Adds a file to a PnP Site Template
+Embeds a file named "Instructions.docx" located in the current folder on the local machine into the PnP Site Template file "template.pnp" located in the current folder on the local machine, instructing it to be uploaded to the default document library when the template is applied to a site.
 
 ### EXAMPLE 2
 ```powershell
-Add-PnPFileToSiteTemplate -Path template.xml -Source $sourceFilePath -Folder $targetFolder
+Add-PnPFileToSiteTemplate -Path c:\temp\template.pnp -Source "c:\temp\Sample.pptx" -Folder "Shared Documents\Samples"
 ```
 
-Adds a file reference to a PnP Site XML Template
+Embeds a file named "Sample.pptx" located in the c:\temp on the local machine into the PnP Site Template file located at "c:\temp\template.pnp" on the local machine, instructing it to be uploaded to the folder Samples located in the default document library when the template is applied to a site.
 
 ### EXAMPLE 3
 ```powershell
@@ -63,7 +67,7 @@ Adds a file to a PnP Site Template with a custom container for the file
 
 ### EXAMPLE 5
 ```powershell
-Add-PnPFileToSiteTemplate -Path template.pnp -SourceUrl "Shared%20Documents/ProjectStatus.docs"
+Add-PnPFileToSiteTemplate -Path template.pnp -SourceUrl "Shared%20Documents/ProjectStatus.docx"
 ```
 
 Adds a file to a PnP Provisioning Template retrieved from the currently connected site. The url can be server relative or web relative. If specifying a server relative url has to start with the current site url.
@@ -99,29 +103,29 @@ Accept wildcard characters: False
 ```
 
 ### -FileLevel
-The level of the files to add. Defaults to Published
+The level of the files to add, defaults to Published.
 
 ```yaml
 Type: FileLevel
 Parameter Sets: (All)
 
 Required: False
 Position: 4
-Default value: None
+Default value: Published
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
 ### -FileOverwrite
-Set to overwrite in site, Defaults to true
+Set to overwrite in site, defaults to true.
 
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
 
 Required: False
 Position: 5
-Default value: None
+Default value: $true
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
@@ -155,7 +159,7 @@ Accept wildcard characters: False
 ```
 
 ### -Source
-The file to add to the in-memory template, optionally including full path.
+The file to add to the PnP Provisioning Template, optionally including full path.
 
 ```yaml
 Type: String
@@ -169,7 +173,7 @@ Accept wildcard characters: False
 ```
 
 ### -SourceUrl
-The file to add to the in-memory template, specifying its url in the current connected Web.
+The file to add to the PnP Provisioning Template, specifying its url in the current connected Web.
 
 ```yaml
 Type: String
@@ -196,10 +200,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-
-
 ## RELATED LINKS
 
-[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
-
-
+[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)