Provisioning SPFx Solutions to SharePoint Online using PnP, ALM APIs and more!
Download as PPTX, PDF1 like1,498 views
The document discusses provisioning SharePoint Framework (SPFx) solutions to SharePoint Online using different methods, including REST APIs and the PnP provisioning engine. It outlines the challenges associated with app provisioning, particularly regarding app-only authentication and site collection scoped app catalogs. Additionally, it provides code examples for adding, deploying, and installing apps using API calls and highlights the benefits of using the PnP core library for app management.
Provisioning SPFx Solutions to SharePoint Online using PnP, ALM APIs and more!
- 1. rencore.comrencore.com Provisioning SPFx Solutions to SharePoint Online using PnP, ALM APIs and more! SPS Helsinki, January 2018
- 2. Thank you to our sponsors!
- 3. rencore.com Erwin van Hunen Product Owner Transformation Tooling MVP Office Servers and Services PnP Core Team Member Microsoft Certified Master erwin.van.hunen@rencore.com @erwinvanhunen
- 4. rencore.com What are your options? •By hand •No. Just no. •Through an API •REST API… but… •Through the PnP Provisioning Engine
- 5. rencore.com •APIs only available with SharePoint Online •APIs do not work with app-only auth •Basically no way to programmatically provisioning Apps on SP2016 •Currently no support of Site Collection Scoped AppCatalogs It’s all about the trust…
- 6. rencore.com Add Deploy Install REST API – The Basic Flow
- 7. rencore.com /_api/web/tenantappcatalog/Add(overwrite=true, url='test.txt’) REST API – Adding an app This is a token, do not replace with the actual url of the appcatalog Synchronous
- 8. rencore.com /_api/web/tenantappcatalog/AvailableApps REST API – Listing all available apps Synchronous
- 9. rencore.com /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxx xxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Deploy REST API – Deploying an app Synchronous Context: app catalog site
- 10. rencore.com /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxx xxx-xxxx-xxxx-xxxx-xxxxxxxxxx’)/Install REST API – Installing an app Asynchronous!
- 11. rencore.com /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxx xxx-xxxx-xxxx-xxxx-xxxxxxxxxx’)/Uninstall REST API – Uninstalling an app Asynchronous!
- 12. rencore.com • There are also endpoints for removing, upgrading. • See more at https://docs.microsoft.com/en- us/sharepoint/dev/apis/alm-api-for-spfx-add-ins Additional endpoints
- 13. rencore.com • Search contentclass:STS_Site AND SiteTemplate:APPCATALOG • CSOM var tenantSettings = TenantSettings.GetCurrent(web.Context); web.Context.Load(tenantSettings, t => t.CorporateCatalogUrl); web.Context.ExecuteQuery(); Gotchas: retrieving the APP Catalog Site Url
- 14. rencore.com • PnP Core Library web.GetAppCatalog(); • PnP PowerShell Get-PnPTenantAppCatalogUrl Gotchas: retrieving the APP Catalog Site Url
- 15. rencore.com • PnP Core Library web.GetAppCatalog(); • PnP PowerShell Get-PnPTenantAppCatalogUrl Gotchas: retrieving the APP Catalog Site Url
- 16. rencore.com var manager = new AppManager(ClientContext); var result = manager.Add(bytes, filename, overwrite); manager.Deploy(result.Id,SkipFeatureDeployment); manager.Install(result.Id); PnP Core - Why write it all yourself?
- 17. rencore.com • The AppManager class is a nice resource to see how to build REST queries • The AppManager class takes care of context switching to the appcatalog, and will figure out the URL of the appcatalog for you. PnP Core - Why write it all yourself?
- 18. rencore.com Get-PnPApp Add-PnPApp Publish-PnPApp (to deploy) Install-PnPApp Uninstall-PnPApp Unpublish-PnPApp (to retract) Remove-PnPApp Quick prototype? PnP PowerShell
- 20. rencore.com PnP Provisioning Engine <pnp:ProvisioningTemplate ID="SPECIALTEAM" Version="1.0"…> <pnp:ApplicationLifecycleManagement> <pnp:Apps> <pnp:App AppId="{AppPackageId:spshel.sppkg}" Action="Install" /> </pnp:Apps> </pnp:ApplicationLifecycleManagement> </pnp:ProvisioningTemplate>
- 21. rencore.com • Installing an app is asynchronous! • We are working on making the app install a synchronous experience in the Provisioning Engine Caveats
- 23. Thank you! bit.ly/spshel2018 Please rate this session
Editor's Notes
- #2: To add your image, first delete the place holder image as shown in the white box. Then insert your picture and scale it to be bigger than the size of the white box shown. Finally, right click on your image and select ‘Send to back’ – your image should now be framed correctly. Please add co-speaker image directly below, if applicable