The SharePoint Embedded Visual Studio Code extension helps developers get started with SharePoint Embedded application development. With the extension, developers can:

1. Create and configure Azure Entra app registrations for use with SharePoint Embedded
2. Create and manage free trial container types
3. Create additional guest apps on a free trial container type
4. Load one of the sample apps and auto-populate its runtime configuration
5. Export Container Type and Azure Entra app settings to a Postman Environment file for use with the SharePoint Embedded Postman Collection

In order to use this extension, you'll need to sign into a Microsoft 365 tenant with an administrator account.

If you don't have administrator access to a Microsoft 365 tenant, get your own tenant with the Microsoft 365 Developer Program.

Once you've signed in, the first (and only) thing to do next is to create a free trial container type. A free trial container type lets you get started calling SharePoint Embedded APIs and building a proof-of-concept application using SharePoint Embedded.

Every container type is owned by an Azure Entra (AD) application. The first step when creating a free trial container type is to create a new or select an existing Azure Entra application as the owning application. You can either specify the name of your new application or pick one of your existing applications.

Note that if you choose an existing application, the extension will update that app's configuration settings in order for it to work with both SharePoint Embedded and this extension. Doing this is NOT recommended on production applications.

Once you have an Azure Entra application, the last step is to provide a name for your new free trial container type

With a free trial container type created, you can use the extension to load one of the SharePoint Embedded sample apps and automatically populate the runtime configuration file with the details of your Azure Entra app and container type. This allows you to immediately run the sample app on your local machine.

The SharePoint Embedded Postman Collection allows you to explore and call the SharePoint Embedded APIs. The Collection requires an environment file with variables used for authentication and various identifiers. This extension automates the generation of this populated environment file so you can import it into Postman and immediately call the SharePoint Embedded APIs.

You can use the extension to add one or more guest apps on your existing free trial container type. Guest apps can be used to create different applications that have access to the same set of Containers. For example, you might have one app that delivers your Web experiences, another for mobile experiences, and another for background processing. You can specify both the delegated and application permissions on each guest application you create.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

• Submit bugs and feature requests
• Review source code changes
• Review the documentation and make pull requests for anything from typos to new features

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at Microsoft Privacy Statement. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

Telemetry collection is on by default. To opt out, please set the telemetry.enableTelemetry setting to false. Learn more in our FAQ.

Give security researchers information on how to privately report security vulnerabilities found in your open-source project. See more details Reporting security issues.

See Microsoft Open Source code of conduct.

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.