Requirement: Connect to SharePoint Online with Azure Active Directory Application from PowerShell.
How to Connect to SharePoint Online using Azure Application ID from PowerShell?
Using Azure Application ID to connect to SharePoint Online is a great way to manage your SharePoint Online environment from unattended PowerShell scripts. In this post, we’ll go over the necessary steps to connect to SharePoint Online using the Azure Application ID from PowerShell.
Step 1: Setup Azure AD Application ID
To connect with SharePoint Online using Azure Application ID, the following steps are necessary:
- Register an Azure AD Application
- Grant Permission to the App
- Create a certificate and upload it to Azure App secret
Register an Azure App
The first step is creating a new app in the Azure App registrations.
- Log in to the Azure portal as Global Admin at https://aad.portal.azure.com
- Click on “Azure Active Directory” and then “App registrations”.
- Click on “Register an application” or the “New registration” button.
- Enter the name of your app and let the default options, and then click on “Register”.
- You’ll be taken into the app summary. Make a note of the Application ID.
Grant Permissions to the Azure Application
Once the app is created, we have to grant necessary access to the app. In our case, We are planning to use this App ID in our PowerShell scripts for SharePoint Online. So, We have to grant SharePoint Application permission: Full Control.
- From the created app summary page, click on “API permissions” in the left navigation link and then click on “Add a permission”.
- In the “Request API permissions” page, Select “SharePoint”.
- Select Application permissions >> Select “Sites.FullControl.All” and click on “Add permissions”.
- Click on “Grant admin consent” to consent to the permissions.
Create a Certificate and Upload it to the App Secret
The next step is creating a secret to the App. Although passwords works, it’s less preferable compared with certificates. So, we need a Self-signed certificate to upload to the application.
$CertificateName = "SharePoint Online Certificate" $CertificatePassword = "Password1" #Get the "Documents" folder $DocumentsFolder = [Environment]::GetFolderPath("MyDocuments") #Generate a Self-signed Certificate $Certificate = New-SelfSignedCertificate -Subject $CertificateName -CertStoreLocation "Cert:\CurrentUser\My" -KeyExportPolicy Exportable -KeySpec Signature -KeyLength 2048 -KeyAlgorithm RSA -HashAlgorithm SHA256 #Export the Certificate to "Documents" Folder in your computer Export-Certificate -Cert $Certificate -FilePath $DocumentsFolder\$CertificateName.cer #Export the PFX File Export-PfxCertificate -Cert $Certificate -FilePath "$DocumentsFolder\$CertificateName.pfx" -Password (ConvertTo-SecureString -String $CertificatePassword -Force -AsPlainText)
More on creating self-signed certificate is here: https://learn.microsoft.com/en-us/azure/active-directory/develop/howto-create-self-signed-certificate
Once the certificate is generated, the next step is to upload the certificate to the application secret.
- Go to your Azure app >> Click on “Certificates & secrets”.
- Click on “Upload certificate”.
- Browse to the CER file generated and click on the “Add” button.
- Make a note of the “Thumbprint”. That’s your secure key associated with the certificate to authenticate to the application.
That’s all! Once you have completed all of these steps, you will be able to connect to SharePoint Online using the Azure Application ID from PowerShell!
Alternate Approach: PowerShell to Register App, Grant Permissions, and Client Secret
The above steps can be automated using a PowerShell script without going through the web user interface. Open the PowerShell console as Administrator and run this script:
Register-PnPAzureADApp -ApplicationName "SharePointApp" -Tenant "Crescent.com" -Store CurrentUser -SharePointApplicationPermissions "Sites.FullControl.All" -Interactive
This script registers a new Azure AD Application, creates a new self-signed certificate, and adds it to the local certificate store. It will also upload the certificate to the azure app registration.
You’ll get a prompt to consent following permissions: “Sites.FullControl.All”. Login and accept the permission request.
Make a note of Application ID/ClientID and Thumbprint.
Now, we are good to proceed with connecting to SharePoint Online with PnP PowerShell.
Step 2: Connect to SharePoint Online using App ID and Certificate
Once the Azure AD application is ready, you can connect to SharePoint Online from PnP PowerShell as:
#Parameters $SiteURL = "https://Crescent.sharepoint.com/sites/retail" $ClientID = "3735f461-fdb5-4360-8184-b30345e57796" $ThumbPrint = "EE4C7845D6794F7525C2482551C2AC89F6B9CEE1" $Tenant = "Crescent.com" #Connect to SharePoint Online using Certificate Connect-PnPOnline -Url $SiteURL -ClientId $ClientID -Thumbprint $ThumbPrint -Tenant $Tenant #Get the Site Get-PnPSite
Anyone who needs to connect to SharePoint Online with the App must install the certificate in their local machine first, and then use the Client ID and the certificate thumbprint to authenticate.