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: articles/cosmos-db/vercel-integration.md
+26-14Lines changed: 26 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,50 +21,62 @@ This documentation is designed for developers seeking to effectively combine the
21
21
22
22
This integration enables developers to apply the benefits of a versatile and high-performance NoSQL database, while capitalizing on Vercel's serverless architecture and development platform.
## Integrate Cosmos DB with Vercel via Integration Marketplace
30
30
31
-
Use this guide if you have already identified the Vercel project(s) or want to integrate an existing vercel project with
31
+
Use this guide if you have already identified the Vercel projects or want to integrate an existing vercel project with
32
32
33
33
## Prerequisites
34
34
35
35
- Vercel Account with Vercel Project – [Learn how to create a new Vercel Project](https://vercel.com/docs/concepts/projects/overview#creating-a-project)
36
36
37
37
- Azure Cosmos DB - [Quickstart: Create an Azure Cosmos DB account](../cosmos-db/nosql/quickstart-portal.md) or Create a free [Try Cosmos DB Account](https://aka.ms/trycosmosdbvercel)
38
38
39
-
- Some basic knowledge on Next.js, React and TypeScript
39
+
- Some basic knowledge on Next.js, React, and TypeScript
40
40
41
41
## Steps for Integrating Azure Cosmos DB with Vercel
42
42
43
43
1. Select Vercel Projects for the Integration with Azure Cosmos DB. After you have the prerequisites ready, visit the Cosmos DB [integrations page on the Vercel marketplace](https://vercel.com/integrations/azurecosmosdb) and select Add Integration
44
44
45
45
:::image type="content" source="./media/integrations/vercel/add-integration.png" alt-text="Screenshot shows the Azure Cosmos DB integration page on Vercel's marketplace." lightbox="./media/integrations/vercel/add-integration.png":::
46
46
47
-
2. Choose All projects or Specific projects for the integration. In this guide we proceed by choosing specific projects, select continue
47
+
2. Choose All projects or Specific projects for the integration. In this guide we proceed by choosing specific projects. Select Install to continue.
48
48
49
49
:::image type="content" source="./media/integrations/vercel/continue.png" alt-text="Screenshot shows to select vercel projects." lightbox="./media/integrations/vercel/continue.png":::
50
50
51
-
3.Next screen will show the required permissions for the integration, select Add Integration
51
+
3.Sign in to your existing Microsoft account, or if you don’t have one, create a new account as depicted in next step.
52
52
53
-
:::image type="content" source="./media/integrations/vercel/permissions.png" alt-text="Screenshot shows the permissions required for the integration." lightbox="./media/integrations/vercel/permissions.png":::
53
+
:::image type="content" source="./media/integrations/vercel/sign-in.png" alt-text="Screenshot shows to log in to Azure account." lightbox="./media/integrations/vercel/sign-in.png":::
54
54
55
-
4. Log in to Azure using your credentials to select the existing Azure Cosmos DB account for the integration
55
+
4. Click on 'create one' to create a new Microsoft account.
56
+
> [!NOTE]
57
+
> Microsoft account is different from an Azure Cosmos DB account. We will be creating an Azure Cosmos DB account in following steps
58
+
>
59
+
:::image type="content" source="./media/integrations/vercel/create-new.png" alt-text="Screenshot shows to create new Microsoft Account." lightbox="./media/integrations/vercel/create-new.png":::
56
60
57
-
:::image type="content" source="./media/integrations/vercel/sign-in.png" alt-text="Screenshot shows to login to Azure account." lightbox="./media/integrations/vercel/sign-in.png":::
61
+
5. If you want to use an existing Azure Cosmos DB account, choose the existing Directory, subscription and the Azure Cosmos DB Account(Skip to step 9) . To create a new Azure Try Cosmos DB account, click on 'Create new account'.
62
+
63
+
:::image type="content" source="./media/integrations/vercel/create-new-azure-cosmosdb.png" alt-text="Screenshot shows to create new Azure Try Cosmos DB Account." lightbox="./media/integrations/vercel/create-new-azure-cosmosdb.png":::
58
64
59
-
5. Choose a Directory, subscription and the Azure Cosmos DB Account
65
+
6. Select API type (currently only NOSQL and MongoDB API are supported) and click on 'Create Account'.
60
66
61
-
6. Verify Vercel Projects
67
+
:::image type="content" source="./media/integrations/vercel/select-api.png" alt-text="Screenshot shows to select the type of API of the Azure Cosmos DB account." lightbox="./media/integrations/vercel/select-api.png":::
62
68
63
-
:::image type="content" source="./media/integrations/vercel/projects.png" alt-text="Screenshot shows to verify the vercel projects for the integration." lightbox="./media/integrations/vercel/projects.png":::
69
+
7. After the successful Try Azure Cosmos DB account creation, click on 'Continue'
64
70
65
-
7. Select Integrate
71
+
:::image type="content" source="./media/integrations/vercel/account-continue.png" alt-text="Screenshot shows to continue with the integration." lightbox="./media/integrations/vercel/account-continue.png":::
66
72
67
-
:::image type="content" source="./media/integrations/vercel/integrate.png" alt-text="Screenshot shows to confirm the integration." lightbox="./media/integrations/vercel/integrate.png":::
73
+
8. Click on 'Accept' in the pop-up to access the Try Azure Cosmos DB account. (Mandatory to complete the Integration).
74
+
75
+
:::image type="content" source="./media/integrations/vercel/accept.png" alt-text="Screenshot shows to accept the access." lightbox="./media/integrations/vercel/accept.png":::
76
+
77
+
9. Select Integrate and you're done.
78
+
79
+
:::image type="content" source="./media/integrations/vercel/integrate-new.png" alt-text="Screenshot shows to confirm the integration." lightbox="./media/integrations/vercel/integrate-new.png":::
68
80
69
81
## Integrate Cosmos DB with Vercel via npm & Command Line
70
82
@@ -88,7 +100,7 @@ Use this guide if you have already identified the Vercel project(s) or want to i
88
100
89
101
- COSMOSDB_CONNECTION_STRING - You need your Cosmos DB connection string. You can find these in the Azure portal in the keys section.
90
102
91
-
- COSMOSDB_DATABASE_NAME - Name of the database you plan to use. This should already exist in the Cosmos DB account.
103
+
- COSMOSDB_DATABASE_NAME - Name of the database you plan to use. This should already exist in the Azure Cosmos DB account.
92
104
93
105
- COSMOSDB_CONTAINER_NAME - Name of the container you plan to use. This should already exist in the previous database.
0 commit comments