You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/embedded/getting-started/spembedded-for-vscode.md
+19-33Lines changed: 19 additions & 33 deletions
Original file line number
Diff line number
Diff line change
@@ -11,46 +11,38 @@ The SharePoint Embedded Visual Studio Code extension helps developers get starte
11
11
12
12
> [!IMPORTANT]
13
13
> To start building with SharePoint Embedded you will need administrative access to Microsoft 365 tenant.
14
-
> If you do not already have a tenant, you can get your own tenant with the [Microsoft 365 Developer Program](https://developer.microsoft.com/microsoft-365/dev-program), [Microsoft Customer Digital Experience](https://cdx.transform.microsoft.com/), or create a free trial of an [Microsoft 365 E3 license](https://www.microsoft.com/en-us/microsoft-365/enterprise/microsoft365-plans-and-pricing).
15
-
14
+
> If you do not already have a tenant, you can get your own tenant with the [Microsoft 365 Developer Program](https://developer.microsoft.com/microsoft-365/dev-program), [Microsoft Customer Digital Experience](https://cdx.transform.microsoft.com/), or create a free trial of an [Microsoft 365 E3 license](https://www.microsoft.com/microsoft-365/enterprise/microsoft365-plans-and-pricing).
16
15
17
16
## Install SharePoint Embedded for Visual Studio Code
18
17
19
18
1. Open a new window in [Visual Studio Code](https://code.visualstudio.com/) and navigate to "**Extensions**" on the activity bar.
20
19
1. Search "SharePoint Embedded" in the Extensions view. You can also view the extension in [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=SharepointEmbedded.ms-sharepoint-embedded-vscode-extension).
21
-
1.Press**"Install"** and the SharePoint Embedded icon will appear on the activity bar.
22
-
1. Select on the icon to open the SharePoint Embedded view and create a container type with trial configuration.
20
+
1.Select**"Install"** and the SharePoint Embedded icon will appear on the activity bar.
21
+
1. Select the icon to open the SharePoint Embedded view and create a container type with trial configuration.
23
22
24
23
25
24
25
+
### Sign in with admin credentials
26
26
27
-
#### Sign in with admin credentials
27
+
To use the extension, you must sign into a Microsoft 365 tenant with an administrator account.
28
28
29
-
To use the extension, you need to sign into a Microsoft 365 tenant with an administrator account.
30
29
If you don't already have a tenant, you can get a tenant through the [Microsoft 365 Developer Program](https://developer.microsoft.com/microsoft-365/dev-program), [Microsoft Customer Digital Experience](https://cdx.transform.microsoft.com/), or create a free trial of an [Microsoft 365 E3 license](https://www.microsoft.com/en-us/microsoft-365/enterprise/microsoft365-plans-and-pricing).
31
30
32
-
33
31
34
32
35
-
36
-
* Authentication opens a new tab in an external browser to grant permissions
37
-
* Select **Accept** on the pop-up window prompting admin consent
38
-
33
+
- Authentication opens a new tab in an external browser to grant permissions
34
+
- Select **Accept** on the pop-up window prompting admin consent
## Create a container type with a trial configuration
42
39
43
-
44
-
45
-
46
-
## Create a container type with trial configuration
47
-
48
-
Once signed in, you are prompted to create a [container type with trial configuration](../concepts/app-concepts/containertypes.md#trial-use). A container type lets you get started calling SharePoint Embedded APIs and building a proof-of-concept application using SharePoint Embedded. Learn more about [container types](../concepts/app-concepts/containertypes.md).
40
+
Once signed in, you are prompted to create a [container type with trial configuration](../concepts/app-concepts/containertypes.md#trial-use). A container type lets you get started calling SharePoint Embedded APIs and building a proof-of-concept application using SharePoint Embedded. Learn more about [container types](../concepts/app-concepts/containertypes.md).
@@ -61,32 +53,28 @@ Once signed in, you are prompted to create a [container type with trial configu
61
53
62
54
Every container type is owned by a Microsoft Entra ID application. The first step when creating a free trial container type is to create a new or select an existing Microsoft Entra ID application as the owning application. You can either specify the name of your new application or pick one of your existing applications. Learn more about SharePoint Embedded [app architecture](../concepts/app-concepts/app-architecture.md)
63
55
64
-
* Follow the prompts to name your new Entra application or select an existing application ID
56
+
- Follow the prompts to name your new Entra application or select an existing application ID
> If you choose an existing application, the extension will update that app's configuration settings for it to work with both SharePoint Embedded and this extension. Doing this is NOT recommended on production applications.
70
62
71
-
72
-
After your container type is created and your application is configured, you'll be able to view your Local tenant registration as a tree in the left nav-bar
73
-
63
+
After your container type is created and your application is configured, you'll be able to view your Local tenant registration as a tree in the left nav-bar.
74
64
75
65
## Register your container type
76
66
77
67
After creating your container type, you'll need to register that container type on your local tenant. Learn more about container type [registration](../concepts/app-concepts/register-api-documentation.md).
78
68
79
-
* Follow the prompt and select **'Register on local tenant'** on the lower right corner of the VS Code window
80
-
* If you don't see the prompt, you can right-click on your `<container-type-name>` and select **Register** from the menu
69
+
- Follow the prompts and select **'Register on local tenant'** on the lower right corner of the VS Code window
70
+
- If you don't see the prompt, you can right-click on your `<container-type-name>` and select **Register** from the menu
@@ -95,19 +83,19 @@ An external browser window will pop open for you to sign-in and grant admin cons
95
83
96
84
With your container type registered, you can now create your first container. Only five containers of container type can be created to upload and manage content.
97
85
98
-
* Right-click on the **Containers** drop-down from the tree in the left nav-bar and select **Create container**
99
-
* Enter a name for the container you would like to create
86
+
- Right-click on the **Containers** drop-down from the tree in the left nav-bar and select **Create container**
87
+
- Enter a name for the container you would like to create
110
97
98
+
111
99
112
100
## Load Sample App
113
101
@@ -120,5 +108,3 @@ With your free trial container type created, you can use the extension to load o
120
108
The [SharePoint Embedded Postman Collection](https://github.com/microsoft/SharePoint-Embedded-Samples/tree/main/Postman) 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.
0 commit comments