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
description: Learn how to connect apps to your Neon Serverless Postgres service using Service Connector in Azure.
4
-
# customerIntent: As a developer I want connect apps deployed to Azure services, to a Neon Serverless Postgres resource.
2
+
title: Connect Apps to Neon Serverless Postgres
3
+
description: Learn how to connect apps to the Neon Serverless Postgres service by using Service Connector in Azure.
4
+
#customer intent: As a developer, I want connect apps deployed in Azure services to a Neon Serverless Postgres resource so that I can take advantage of Neon's capabilities.
5
5
ms.topic: how-to
6
6
ms.date: 03/28/2025
7
7
ms.custom: service-connector
8
8
---
9
9
10
10
# Connect apps to Neon Serverless Postgres
11
11
12
-
In this guide, learn how to connect your app to a database within a Neon Serverless Postgres resource using Service Connector.
12
+
In this guide, learn how to connect your app to a database within a Neon Serverless Postgres resource by using Service Connector.
13
13
14
-
Service Connector is an Azure service designed to simplify the process of connecting Azure resources together. Service Connector manages your connection's network and authentication settings to simplify the operation.
14
+
Service Connector is an Azure feature that simplifies the process of connecting Azure resources together. Service Connector manages your connection's network and authentication settings to simplify the operation.
15
15
16
-
This guide shows step by step instructions to connect an app deployed to Azure App Service to a Neon Serverless Postgres resource. You can apply a similar method to create a connection from apps deployed to[Azure Container Apps](/azure/container-apps/quickstart-portal), [Azure Kubernetes Services (AKS)](/azure/aks/learn/quick-kubernetes-deploy-portal).
16
+
This guide shows step-by-step instructions for connecting an app deployed in Azure App Service to a Neon Serverless Postgres resource. You can apply a similar method to create a connection from apps deployed in[Azure Container Apps](/azure/container-apps/quickstart-portal) or [Azure Kubernetes Service (AKS)](/azure/aks/learn/quick-kubernetes-deploy-portal).
17
17
18
18
## Prerequisites
19
19
20
-
* An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free)
21
-
* An existing Neon Serverless Postgres resource. If you don't have one yet, refer to [create a Neon Serverless Postgres resource](./create.md)
22
-
* An app deployed to an [Azure compute service supported by Service Connector](../../service-connector/overview.md#what-services-are-supported-by-service-connector).
20
+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free).
21
+
- An existing Neon Serverless Postgres resource. If you don't have one yet, refer to [Create a Neon Serverless Postgres resource](./create.md).
22
+
- An app deployed to an [Azure compute service that Service Connector supports](../../service-connector/overview.md#what-services-are-supported-by-service-connector).
23
23
24
-
## Create a new connection
24
+
## Create a connection
25
25
26
26
Follow these steps to connect an app to Neon Serverless Postgres:
27
27
28
28
1. Open the App Service, Container Apps, or AKS resource where your app is deployed.
29
29
30
-
1.Open **Service Connector** from the left menu and select **Create**.
30
+
1.On the left menu, open **Service Connector**, and then select **Create**.
31
31
32
-
:::image type="content" source="./media/service-connection/create-connection.png" alt-text="Screenshot from the Azure portal showing the Create option.":::
32
+
:::image type="content" source="./media/service-connection/create-connection.png" alt-text="Screenshot of the Azure portal that shows the button for creating a connection.":::
|**Service type**|*Neon Serverless Postgres*| The name of the target service: **Neon Serverless Postgres**. |
39
-
|**Connection name**|*neon_postgres_01*| The name of the connection between the Azure compute resource and the Neon Serverless Postgres resource. Use the connection name provided by Service Connector or enter your own connection name. Connection names can only contain letters, numbers (0-9), periods ("."), and underscores ("_"). |
40
-
|**Neon Postgres hostname**|*contoso-compute.gwc.azure.neon.tech*| The host name of the Neon Serverless Postgres resource. The host name is displayed in the Neon portal, in the **Connect** menu, under **Connection string**. |
41
-
|**Neon Postgres database**|*database*| The name of the database within the Neon Serverless Postgres resource. The database name is displayed in the Neon portal, in the **Connect** menu, under **Database**. |
39
+
|**Connection name**|*neon_postgres_01*| The name of the connection between the Azure compute resource and the Neon Serverless Postgres resource. Use the connection name that Service Connector provides, or enter your own connection name. Connection names can contain only letters, numbers (0-9), periods (.), and underscores (_). |
40
+
|**Neon Postgres hostname**|*contoso-compute.gwc.azure.neon.tech*| The host name of the Neon Serverless Postgres resource. The host name is displayed in the Neon portal, on the **Connect** menu, under **Connection string**. |
41
+
|**Neon Postgres database name**|*database*| The name of the database within the Neon Serverless Postgres resource. The database name is displayed in the Neon portal, on the **Connect** menu, under **Database**. |
42
42
|**Client type**|*Python*| The database client type. |
43
-
44
-
:::image type="content" source="./media/service-connection/create-basics-tab.png" alt-text="Screenshot from the Azure portal showing the Create connection - Basics tab.":::
45
43
46
-
1. Select **Next: Authentication** and select or enter the following information:
47
-
1. Select **Database credentials** and enter your database username and password.
48
-
1. Select **Store Secret in Key Vault** and select a Key Vault connection if you already have one, or select **Create new** to create a Key Vault connection. For step-by-step instructions to create a new connection to Key Vault, refer to [Connect Azure services and store secrets in Azure Key Vault](../../service-connector/tutorial-portal-key-vault.md#create-a-key-vault-connection-in-app-service).
49
-
1. Optionally also select **Advanced** and edit the provided environment variables.
44
+
:::image type="content" source="./media/service-connection/create-basics-tab.png" alt-text="Screenshot of the Azure portal that shows the Basics tab for creating a connection.":::
50
45
51
-
:::image type="content" source="./media/service-connection/create-authentication-tab.png" alt-text="Screenshot from the Azure portal showing the Create connection - Authentication tab.":::
46
+
1. Select **Next: Authentication**, and then select or enter the following information:
47
+
48
+
1. Select **Database credentials**, and then enter your database username and password.
49
+
1. Select **Store Secret In Key Vault**, and then select an Azure Key Vault connection if you already have one.
50
+
51
+
If you don't have a Key Vault connection, select **Create new** to create one. For step-by-step instructions on creating a new connection to Key Vault, refer to [Connect Azure services and store secrets in Azure Key Vault](../../service-connector/tutorial-portal-key-vault.md#create-a-key-vault-connection-in-app-service).
52
+
1. Optionally, select **Advanced** and edit the provided environment variables.
53
+
54
+
:::image type="content" source="./media/service-connection/create-authentication-tab.png" alt-text="Screenshot of the Azure portal that shows the Authentication tab for creating a connection.":::
52
55
53
56
> [!NOTE]
54
-
> We recommend you leverage Azure Key Vault to securely store and manage your credentials, reduce the risk of exposure and simplify secret management.
57
+
> We recommend that you use Azure Key Vault to securely store and manage your credentials, reduce the risk of exposure, and simplify secret management.
- You must [subscribe to Neon](overview.md#subscribe-to-neon).
17
18
18
19
## Create a resource
@@ -21,60 +22,52 @@ This quickstart shows you how to create a Neon Serverless Postgres resource usin
21
22
22
23
### Basics tab
23
24
24
-
The *Basics* tab has three sections:
25
-
26
-
- Project details
27
-
- Azure Resource details
28
-
- New Organization details
29
-
30
-
:::image type="content" source="media/create/basics-tab.png" alt-text="Screenshot from the Azure portal showing the Basics tab to create a new Neon resource.":::
25
+
The **Basics** tab has sections for details about the project, the Azure resource, and the Neon organization. Red asterisks identify required settings.
31
26
32
-
There are required fields in each section that you need to fill out.
27
+
:::image type="content" source="media/create/basics-tab.png" alt-text="Screenshot of the Azure portal that shows the Basics tab to create a new Neon resource.":::
33
28
34
-
1.Enter the values for each required setting under *Project details*.
|Organization |Specify a name for the organization. |
53
-
|Plan |Select the **Change plan** link and choose the plan you want. |
47
+
|**Organization name**|Specify a name for the organization. |
48
+
|**Plan**|Select the **Change Plan** link and choose the plan that you want. |
54
49
55
-
The remaining fields update to reflect the details of the plan you selected for this new organization.
50
+
The remaining settings update themselves to reflect the details of the plan that you selected for this new organization.
56
51
57
-
1. Select the **Next** button at the bottom of the page.
52
+
1. Select **Next**.
58
53
59
54
### Project tab
60
55
61
-
In Neon, everything starts with a project: the top-level object in the Neon object hierarchy. When you create a project, a default branch and database is automatically created for your project to help you get started.
56
+
In Neon, everything starts with a project: the top-level object in the Neon object hierarchy. When you create a project, a default branch and database are automatically created for your project to help you get started.
62
57
63
-
:::image type="content" source="media/create/project-tab.png" alt-text="Screenshot from the Azure portal showing the Project tab for the Neon resource.":::
58
+
:::image type="content" source="media/create/project-tab.png" alt-text="Screenshot of the Azure portal that shows the Project tab for a Neon resource.":::
64
59
65
-
- Enter the values for each setting, or continue with the default values for your project.
60
+
On the **Project** tab, enter the values for each setting, or continue with the default values for your project.
|**Project name**|Specify a name for your Neon project. |
65
+
|**Postgres version**|Choose a Postgres version for your project. |
66
+
|**Database name**|Specify a name for your first database in the project. |
67
+
|**Project region**|Choose the region for your database. |
74
68
75
-
> [!NOTE]
76
-
> The *Project region* in this tab corresponds to your database.
77
-
> Don't confuse this value with the *Region* from the Basics tab, which is where your Azure resource is deployed.
69
+
> [!NOTE]
70
+
> The **Project region** value on this pane corresponds to your database. Don't confuse this value with the **Region** value from the **Basics** tab, which is where your Azure resource is deployed.
0 commit comments