Mikko Koskinen
Power Platform, PowerShell, SharePoint
PnP.PowerShell Is Out and Here’s Why it Matters
Good things are worth waiting for. It took around two years but finally, PnP PowerShell (@PnpPowershell) for PowerShell Core, aka PnP.PowerShell is out in a preview, and GA is expected to be realized this year. Big kudos to Erwin (@erwinvanhunen) and his team. More about the journey and roadmap ‘Cross Platform PnP PowerShell Released‘
I am a huge fan of PowerShell and especially the PnP PowerShell library. I still use it almost daily for something, and I think scripting is something that every IT Pro should master at least on some level. As we know, things are evolving quickly, and there is always something new in the IT world. One important thing around PowerShell was PowerShell Core 6 that was announced back in 2014. The PowerShell Core is a cross-platform, free, and open source. For an old-school SharePoint geek (like me), the lack of API and modules against SharePoint Online has been the thing to keep using the Windows PowerShell. Sure, you have been able to use REST before, but the PnP PowerShell module has just been more comfortable.
But now the future is finally here for the oldies everyone. You can find the source code of this post from my GitHub repository.
Things to Consider on PnP PowerShell
Installing the new PnP PowerShell is easy, as usual. Just open the PnP Management Shell and give Install-Module PnP.PowerShell -AllowPrerelease command. Things still are in preview mode, but new cmdlets are added regularly to GitHub. Using the module is almost similar to using the classic version. Here’s an excellent place to start if needed: PnP PowerShell Overview | Microsoft Docs
On a high -level, things to remember for us who have been using the earlier version are:
- The roadmap
- Once the new PnP PowerShell (v4) goes to the GA (scheduled end of 2020), the old v3 version’s development will stop.
- The plan is to archive the v3 repo during Q1 2020
- Start to plan the migration NOW! I just did.
- PnP PowerShell will be available for SharePoint Online only in the future!
- PnP PowerShell runs on top of .NET Core 3.1 / .NET Framework 4.6.1. This means that you need the new cross-platform version of PowerShell to use. You can find the installation instruction from here: Installing PowerShell – PowerShell | Microsoft Docs
- All *-PnPProvisioningTemplate cmdlets have been renamed to *-PnPSiteTemplate. This means that Get-PnPProvisioningTemplate is now, for instance, called Get-PnPSiteTemplate.
- Classic credential-based authentication has changed.
- More info from GitHub (link above)
- WebLogin functionality is not available anymore.
Regarding the login, if you are not familiar with connecting to SharePoint Online using Application Permission, I think this is an excellent time to check out that option. Giving the necessary permission through an Azure AD application will give you more robust tools to control the access for many scripting and integration use cases. Application permission is also crucial to master for a reliable and secure connection for automated tasks and service scenarios. Here’s a basic walkthrough on how to get started.
PnP PowerShell with Azure Functions
I still have not covered the “Here’s Why” section of the title, so here it goes. I think (for me) the major thing of the new release is that moving the PnP library on top of .NET Core means that PnP PowerShell now works natively with Azure Functions type of services. You were, and I have, able to use it before, but the development experience was not good, and there was not an easy way to manage the ALM process for your PowerShell functions. With the new version, all the complexity is gone, and PowerShell is starting to be a real option for service development in many cloud business cases.
As an old developer, I know this will raise the hairs upright among many of my friends, but you should not underestimate PowerShell when creating integrations or services. Yes, by coding, you can do things effectively, and there are multiple cases when PowerShell is not enough.
In many organizations, the situation is that there aren’t too many people who know modern code techniques but there are many who know PowerShell. Now with PnP PowerShell and another available cmdlet and modules, people are able to do even more complex useful programs for their organization.
At the same time, we, the consultants, are responsible for developing services that our clients can use AND maintain. In many cases, there are multiple IT Pro’s that do know PowerShell, but they do not have coding experience. I always try to build my solutions to take whole control of the solution when I am gone. One of my mentors in consulting had one rule; as a consultant, do your job every day so that you may be unnecessary the next day. Therefore, I see PowerShell as a viable option in many cases. By using it, I know multiple people can maintain the solution. This is the same reason why I find Power Platform as an essential platform in the Microsoft ecosystem.
As a consultant, do your job every day so that you may be unnecessary the next day.
To get back to the point, you can now use the PnP PowerShell module easily when building Azure functions. I recommend using a Visual Studio code from the beginning so that you will adopt better ALM practices. If necessary, start your journey by creating a basic Azure function with PowerShell. Here’s a guide for that (select PowerShell as the programming language): Create your first function in Azure using Visual Studio Code | Microsoft Docs
- You should also go through the Application Permission section mentioned above to connect to SharePoint Online in a managed way.
- Maybe the easiest way to connect to SharePoint Online from the automated process is to use Connect-PnPOnline -Url YOUR_URL -ClientId “ClientId” -ClientSecret “Secret.”
- Remember not to add the client id, secret, cert details, etc. straight to your code.
- Use the Application settings of the function to store these values during the development time.
- In production, you should store these values to Azure Key Vault and use Managed Identity to access values, but this goes over this post’s topic.
- For this example, I did save the connection variable to the application settings of the Function App.
- You can download and use the settings for local development with these steps: Connect Azure Functions to Azure Storage using Visual Studio Code | Microsoft Docs¨
- A valuable thing to learn for Azure Function development is Dependency Management.
- More information can be found from here: PowerShell developer reference for Azure Functions | Microsoft Docs
I assume that you have a working local Azure Function development environment based on the “Create your first function in Azure using Visual Studio Code” article above. Here are the steps you need to take to have PnP PowerShell working in your function.
Using PnP PowerShell with Azure Function
- Create a new PowerShell based function with Visual Studio Code.
- I did name mine as Basic-PnPPowerShellCore.
- Then, and this is the most enjoyable part, you need to load the PnP.PowerShell module on your function’s environment.
- Open the requirements.psd1 file and add PnP.PowerShell a dependency on the project.
- When writing this post, the version was 0.xxx, but you should check the current one from GitHub (link above).
- AND THAT’S IT. No more uploading the module manually or anything like that. Things are just rolling natively.
- Create a new Azure AD application for your target environment.
- Give the necessary permission to the application. I did give full control to all sites.
- Also, create a secret that can be used when authenticating against the application with PnP PowerShell.
- I prefer creating an Azure Function App before I publish the function to make the necessary settings, but you can choose to create the application while publishing the function.
- Save the application id, aka client id, and the secret to your function application settings (note what was said before about production).
- Download the Application Settings to your local development environment.
- For a test function, let us do a simple service that returns the site’s URL to the questioner.
- Open the run.ps1 of the function created earlier.
- Add the necessary parameters.
- $env is referring to the Azure Function Application Settings that holds the necessary details to connect to SharePoint Online.
- Of course, you can give these values straight to your code but in production, I recommend using other options.
$connClientId = $env:ConnClientId
$connSecret = $env:ConnSecret
$siteURL = $env:O365DemoURL
- My simple function looks like this:
$response = ""
try {
Connect-PnPOnline -Url $siteURL -ClientId $connClientId -ClientSecret $connSecret
$ctx = Get-PnPContext
$response = $ctx.Url
Disconnect-PnPOnline
}
catch {
$ErrorMessage = $_.Exception.Message
Write-Host "**ERROR: *Basic-PnPPowerShellCore"
Write-Error $ErrorMessage
}
if ($response) {
Write-Host ("Response: " + $response)
# Site details found!
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
StatusCode = [HttpStatusCode]::OK
Body = $response
})
}
else {
# No site details found
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
StatusCode = [HttpStatusCode]::NoContent
})
}
- Next, you can test the function by pressing F5.
- Because we added a new module as a dependency, the first start will take a few minutes when the module is loaded to the local environment.
- After the loading is done, you can test the function by calling the URL of the function.
- When everything goes as planned, you will see the URL of the test site in the browser.
- After this, you can publish the function to Azure Function app from the Visual Code Extension
- I recommend going into Azure Portal and open the Azure Function where you deployed the function.
- From the App, select Functions, and then the function you just created.
- Run a Test against the function to make sure it is working.
- Running the test will also load the dependencies for the first time so that the calls after the initial call are quicker.
- Finally, you could push your code to the git repository or any source control system your organization uses.
Now, imagine what type of scenarios and possibilities the integration to Azure Function is giving to a user who knows PowerShell. In my next post, I will show something interesting regarding Power Platform and PowerShell, but hopefully, this post gives you ideas to continue developing useful services quickly.
Pingback: Project Oakdale and Azure API Management – Mikko Koskinen