Skip to content

Commit e49f63f

Browse files
eerhardtIEvangelist
eerhardt
and
IEvangelist
authored
Update Azure Postgres code (dotnet#2778)
* Update Azure Postgres code The EntityFramwork code to talk to Azure Postgres is incorrect. It needs to be different depending on the version of EF being used. Fix dotnet#2769 * Apply suggestions from code review * More updates * Apply suggestions from code review Co-authored-by: David Pine <[email protected]> * Remove unnecessary trailing new line in markdown --------- Co-authored-by: David Pine <[email protected]>
1 parent 3fe69f2 commit e49f63f

File tree

2 files changed

+47
-39
lines changed

2 files changed

+47
-39
lines changed

‎docs/database/includes/azure-postgresql-client.md

+8-16
Original file line numberDiff line numberDiff line change
@@ -28,24 +28,16 @@ builder.AddNpgsqlDataSource(
2828
"postgresdb",
2929
configureDataSourceBuilder: (dataSourceBuilder) =>
3030
{
31-
if (!string.IsNullOrEmpty(dataSourceBuilder.ConnectionStringBuilder.Password))
32-
{
33-
return;
34-
}
35-
36-
dataSourceBuilder.UsePeriodicPasswordProvider(async (_, ct) =>
31+
if (string.IsNullOrEmpty(dataSourceBuilder.ConnectionStringBuilder.Password))
3732
{
3833
var credentials = new DefaultAzureCredential();
39-
var token = await credentials.GetTokenAsync(
40-
new TokenRequestContext([
41-
"https://ossrdbms-aad.database.windows.net/.default"
42-
]), ct);
43-
44-
return token.Token;
45-
},
46-
TimeSpan.FromHours(24),
47-
TimeSpan.FromSeconds(10));
34+
var tokenRequest = new TokenRequestContext(["https://ossrdbms-aad.database.windows.net/.default"]);
35+
36+
dataSourceBuilder.UsePasswordProvider(
37+
passwordProvider: _ => credentials.GetToken(tokenRequest).Token,
38+
passwordProviderAsync: async (_, ct) => (await credentials.GetTokenAsync(tokenRequest, ct)).Token);
39+
}
4840
});
4941
```
5042

51-
The preceding code snippet demonstrates how to use the <xref:Azure.Identity.DefaultAzureCredential> class from the <xref:Azure.Identity> package to authenticate with [Microsoft Entra ID](/azure/postgresql/flexible-server/concepts-azure-ad-authentication) and retrieve a token to connect to the PostgreSQL database. The [UsePeriodicPasswordProvider](https://www.npgsql.org/doc/api/Npgsql.NpgsqlDataSourceBuilder.html#Npgsql_NpgsqlDataSourceBuilder_UsePeriodicPasswordProvider_System_Func_Npgsql_NpgsqlConnectionStringBuilder_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask_System_String___System_TimeSpan_System_TimeSpan_) method is used to provide the token to the connection string builder.
43+
The preceding code snippet demonstrates how to use the <xref:Azure.Identity.DefaultAzureCredential> class from the <xref:Azure.Identity> package to authenticate with [Microsoft Entra ID](/azure/postgresql/flexible-server/concepts-azure-ad-authentication) and retrieve a token to connect to the PostgreSQL database. The [UsePasswordProvider](https://www.npgsql.org/doc/api/Npgsql.NpgsqlDataSourceBuilder.html#Npgsql_NpgsqlDataSourceBuilder_UsePasswordProvider_System_Func_Npgsql_NpgsqlConnectionStringBuilder_System_String__System_Func_Npgsql_NpgsqlConnectionStringBuilder_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask_System_String___) method is used to provide the token to the data source builder.

‎docs/database/includes/azure-postgresql-ef-client.md

+39-23
Original file line numberDiff line numberDiff line change
@@ -21,31 +21,47 @@ dotnet add package Azure.Identity
2121

2222
---
2323

24-
The PostgreSQL connection can be consumed using the client integration and <xref:Azure.Identity>:
24+
The PostgreSQL connection can be consumed using the client integration and <xref:Azure.Identity>.
25+
26+
The following code snippets demonstrate how to use the <xref:Azure.Identity.DefaultAzureCredential> class from the <xref:Azure.Identity> package to authenticate with [Microsoft Entra ID](/azure/postgresql/flexible-server/concepts-azure-ad-authentication) and retrieve a token to connect to the PostgreSQL database. The [UsePasswordProvider](https://www.npgsql.org/doc/api/Npgsql.NpgsqlDataSourceBuilder.html#Npgsql_NpgsqlDataSourceBuilder_UsePasswordProvider_System_Func_Npgsql_NpgsqlConnectionStringBuilder_System_String__System_Func_Npgsql_NpgsqlConnectionStringBuilder_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask_System_String___) method is used to provide the token to the data source builder.
27+
28+
### EF Core version 8
2529

2630
```csharp
27-
builder.AddNpgsqlDbContext<YourDbContext>(
28-
"postgresdb",
29-
configureDataSourceBuilder: (dataSourceBuilder) =>
31+
var dsBuilder = new NpgsqlDataSourceBuilder(builder.Configuration.GetConnectionString("postgresdb"));
32+
if (string.IsNullOrEmpty(dsBuilder.ConnectionStringBuilder.Password))
3033
{
31-
if (!string.IsNullOrEmpty(dataSourceBuilder.ConnectionStringBuilder.Password))
32-
{
33-
return;
34-
}
35-
36-
dataSourceBuilder.UsePeriodicPasswordProvider(async (_, ct) =>
37-
{
38-
var credentials = new DefaultAzureCredential();
39-
var token = await credentials.GetTokenAsync(
40-
new TokenRequestContext([
41-
"https://ossrdbms-aad.database.windows.net/.default"
42-
]), ct);
43-
44-
return token.Token;
45-
},
46-
TimeSpan.FromHours(24),
47-
TimeSpan.FromSeconds(10));
48-
});
34+
var credentials = new DefaultAzureCredential();
35+
var tokenRequest = new TokenRequestContext(["https://ossrdbms-aad.database.windows.net/.default"]);
36+
37+
dsBuilder.UsePasswordProvider(
38+
passwordProvider: _ => credentials.GetToken(tokenRequest).Token,
39+
passwordProviderAsync: async (_, ct) => (await credentials.GetTokenAsync(tokenRequest, ct)).Token);
40+
}
41+
42+
builder.AddNpgsqlDbContext<MyDb1Context>(
43+
"postgresdb",
44+
configureDbContextOptions: (options) => options.UseNpgsql(dsBuilder.Build()));
4945
```
5046

51-
The preceding code snippet demonstrates how to use the <xref:Azure.Identity.DefaultAzureCredential> class from the <xref:Azure.Identity> package to authenticate with [Microsoft Entra ID](/azure/postgresql/flexible-server/concepts-azure-ad-authentication) and retrieve a token to connect to the PostgreSQL database. The [UsePeriodicPasswordProvider](https://www.npgsql.org/doc/api/Npgsql.NpgsqlDataSourceBuilder.html#Npgsql_NpgsqlDataSourceBuilder_UsePeriodicPasswordProvider_System_Func_Npgsql_NpgsqlConnectionStringBuilder_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask_System_String___System_TimeSpan_System_TimeSpan_) method is used to provide the token to the connection string builder.
47+
### EF Core version 9+
48+
49+
With EF Core version 9, you can use the `ConfigureDataSource` method to configure the `NpgsqlDataSourceBuilder` that's used by the integration instead of building one outside of the integration and passing it in.
50+
51+
```csharp
52+
builder.AddNpgsqlDbContext<MyDb1Context>(
53+
"postgresdb",
54+
configureDbContextOptions: (options) => options.UseNpgsql(npgsqlOptions =>
55+
npgsqlOptions.ConfigureDataSource(dsBuilder =>
56+
{
57+
if (string.IsNullOrEmpty(dsBuilder.ConnectionStringBuilder.Password))
58+
{
59+
var credentials = new DefaultAzureCredential();
60+
var tokenRequest = new TokenRequestContext(["https://ossrdbms-aad.database.windows.net/.default"]);
61+
62+
dsBuilder.UsePasswordProvider(
63+
passwordProvider: _ => credentials.GetToken(tokenRequest).Token,
64+
passwordProviderAsync: async (_, ct) => (await credentials.GetTokenAsync(tokenRequest, ct)).Token);
65+
}
66+
})));
67+
```

0 commit comments

Comments
 (0)