Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 3.63 KB

MIGRATE-2.0-to-3.0.md

File metadata and controls

64 lines (43 loc) · 3.63 KB
Raw

Updating from PnP PowerShell 2.x to 3.x

This is a draft document, version 3 is not yet available. You can try this out with the nightly builds starting from 2.99.1 or later

The 3.x version of PnP PowerShell is based exclusively on .NET 8.0, which means that it will not work on older PowerShell editions like PowerShell 5.1, ISE or PowerShell 7.3 or older. It will work only on PowerShell 7.4 or later editions.

Steps to update from 2.x to 3.x

Or

  • For Windows environments, please use this link

  • For Linux based environments, please use this link

  • For Mac OS environments, please use this link

Once the PowerShell 7.4 or later is downloaded and installed in the environment, you can install the PnP PowerShell module like you normally do.

Install-Module -Name "PnP.PowerShell"

If you want to install or update to the latest nightly built prerelease of PnP PowerShell, run:

Install-Module -Name "PnP.PowerShell" -AllowPrerelease

Changes needed in Azure DevOps/GitHub Actions/Pipelines

If you are using PnP PowerShell in Azure Devops, GitHub Actions or other pipeline infrastructure, you will have to update your PowerShell version from v5 to v7.4 or later.

Recommend referring to these 2 links:

Breaking changes in 3.0

Cmdlet Comment
Get-PnPRetentionLabel The Get-PnPRetentionLabel cmdlet has been renamed to Get-PnPTenantRetentionLabel
Get-PnPLabel The Get-PnPLabel cmdlet has been renamed to Get-PnPRetentionLabel
Get-PnPPowerPlatformConnector The Get-PnPPowerPlatformConnector cmdlet has been renamed to Get-PnPPowerPlatformCustomConnector
Connect-PnPOnline Using Connect-PnPOnline without specifying an authentication option will now default to using an interactive login. If you still want to use logon using client credentials, provide them using -Credentials instead
Publish-PnPCompanyApp The Publish-PnPCompanyApp cmdlet has been removed
Set-PnPLabel Use Set-PnPRetentionLabel
Reset-PnPLabel Use Reset-PnPRetentionLabel
Add-PnPTeamsChannel The parameter IsFavoriteByDefault has been removed as it was not supported by Graph API
Get-PnPAppAuthAccessToken It has been removed. Use Get-PnPAccessToken -ResourceTypeName SharePoint instead to get SharePoint access token.
Request-PnPAccessToken It has been removed. Use Get-PnPAccessToken instead.
Get-PnPGraphAccessToken It has been removed. Use Get-PnPAccessToken instead.
Remove-PnPUser The parameter -Confirm has been removed. Use -Force instead.
Remove-PnPAvailableSiteClassification The parameter -Confirm has been removed. Use -Force instead.

Other notable changes

Changes to output type

Cmdlet Comment
Get-PnPAccessToken The output type is now Microsoft.IdentityModel.JsonWebTokens.JsonWebToken, earlier it was System.IdentityModel.Tokens.Jwt