Building apps with SharePoint Embedded can be exciting, but it can also feel a bit tricky at times. To make things easier for developers like us, Microsoft created a special tool called the SharePoint Embedded Visual Studio Code extension. This handy extension has a bunch of features that can save us time and headaches.
From quickly finding information about our app's containers to automatically creating the necessary credentials, this extension does a lot of the heavy lifting. It even comes with example apps to get us started!
In this article, we'll dive into the 9 most helpful features of this extension and see how they can make our development journey smoother.
Feature 1 - View a Complete Container Type Hierarchy
Getting a bird's-eye view of your SharePoint Embedded environment just got easier. The extension provides a clear, hierarchical view of all your container types. You can easily see which app owns each type, and how they all relate to each other. This eliminates the need to hunt down information across different screens, giving you a single source of truth for your container types.
Feature 2 - Inspect Container Type Properties
Need to know the nitty-gritty details about a specific container type? No problem! With a simple right-click, the extension displays all the container type properties in a clear JSON format. This includes crucial information like the owning application ID, container type ID, and billing details. This quick access to property data is invaluable when developing your solutions, saving you valuable time.
Feature 3 - Find Owning Apps for Container Types
Ever struggled to figure out which app is responsible for a particular container type? This extension makes it a breeze! The hierarchical view clearly shows the relationship between container types and their owning apps. You can even quickly grab the app ID, which is essential for many development tasks. No more tedious searches – find the information you need instantly.
Feature 4 - Dive Deep into Container Properties
Delving into the specifics of a particular container? This extension makes it a snap! With a simple right-click, you can access all the container's properties in a user-friendly JSON format. This includes vital information like the container type ID, status, and permissions. This detailed view empowers you to understand your containers better and build more robust applications.
Feature 5 - Automated Container Type Registration
Registering your container type in your tenant used to be a bit of a chore. But with this extension, it's a breeze! The extension automates the registration process, including creating the necessary self-signed certificate for your owning app. It even checks and configures your owning app's properties for you. This streamlined approach saves you time and effort, letting you focus on building your application.
Feature 6 - Generate Client Secrets with Ease
Tired of manually creating client-secret credentials? This extension simplifies the process significantly. With a few clicks, you can generate credentials directly within the extension, saving you valuable time and effort. The extension creates a new entry in your app's secrets with the description SharePointEmbeddedVSCode
, making it easy to identify. You can then easily copy the secret value for use in your development. Say goodbye to tedious manual steps!
Feature 7 - Create Self-Signed Certificates Effortlessly
Need a self-signed certificate for your application? The extension makes it incredibly easy to generate one. With a few clicks, you can create a self-signed certificate directly within the extension and have it automatically added to your owning app's certificates tab with the description 'CN=SharePoint Embedded VS Code Ext.' This eliminates the hassle of manual certificate generation and ensures a smooth development process.
Feature 8 - Kickstart Your Project with Sample Apps
Starting from scratch can be daunting. That's why the extension includes a fantastic feature: running sample apps. You can choose from a TypeScript/React-based sample (link) or a C#-based option (link), depending on your preferred language. These pre-built examples provide a solid foundation for your own applications, allowing you to learn and experiment quickly. It's a fantastic way to get a head start on your development journey.
Feature 9 - Streamline Postman Testing with Environment Export
Testing your application with Postman? The extension simplifies the setup process by allowing you to easily export environment settings directly from your owning app. You can either export these settings to a file or conveniently copy them directly to your clipboard. This includes crucial information like your container type ID and other necessary details. You can then import these settings into your Postman environment, saving you time and ensuring accurate testing. This feature streamlines your testing workflow and helps you quickly validate your application's functionality.
Conclusion
In this article, we've explored some of the most valuable features of the SharePoint Embedded Visual Studio Code extension. From easily navigating your container types and accessing key information to automating credential generation and running sample applications, this extension offers a wealth of time-saving features. By leveraging these tools, you can significantly streamline your development process and build robust SharePoint Embedded applications with greater efficiency. So, don't wait! Install the extension today and experience the difference firsthand.
References
- SharePoint Embedded for Visual Studio Code: https://learn.microsoft.com/en-us/sharepoint/dev/embedded/getting-started/spembedded-for-vscode
- SharePoint Embedded Visual Studio Extension: https://marketplace.visualstudio.com/items?itemName=SharepointEmbedded.ms-sharepoint-embedded-vscode-extension&ssr=false#overview
- SharePoint Embedded ASP.Net sample app: https://github.com/microsoft/SharePoint-Embedded-Samples/tree/main/Samples/asp.net-webservice
- SharePoint Embedded TypeScript + React sample app: https://github.com/microsoft/SharePoint-Embedded-Samples/tree/main/Samples/spe-typescript-react-azurefunction
Top comments (0)