Azure 资源管理器 PostgreSQL .NET

azure-resource-manager-postgresql-dotnet
分类通用
作者Agentic Awesome Skills 社区
许可MIT
评分4.60/5
使用15.3K

Azure.ResourceManager.PostgreSql (.NET)

用于管理 PostgreSQL 灵活服务器部署的 Azure Resource Manager SDK。

安装

bash
dotnet add package Azure.ResourceManager.PostgreSql
dotnet add package Azure.Identity

当前版本: v1.2.0 (GA)
API 版本: 2023-12-01-preview

> 注意: 本技能专注于 PostgreSQL 灵活服务器。单服务器(Single Server)已弃用并计划停用。

环境变量

bash
AZURE_SUBSCRIPTION_ID=<your-subscription-id>
AZURE_RESOURCE_GROUP=<your-resource-group>
AZURE_POSTGRESQL_SERVER_NAME=<your-postgresql-server>

身份验证

csharp
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.PostgreSql;
using Azure.ResourceManager.PostgreSql.FlexibleServers;

ArmClient client = new ArmClient(new DefaultAzureCredential());

资源层级

code
Subscription (订阅)
└── ResourceGroup (资源组)
    └── PostgreSqlFlexibleServer              # PostgreSQL 灵活服务器实例
        ├── PostgreSqlFlexibleServerDatabase  # 服务器内的数据库
        ├── PostgreSqlFlexibleServerFirewallRule # IP 防火墙规则
        ├── PostgreSqlFlexibleServerConfiguration # 服务器参数
        ├── PostgreSqlFlexibleServerBackup    # 备份信息
        ├── PostgreSqlFlexibleServerActiveDirectoryAdministrator # Entra ID 管理员
        └── PostgreSqlFlexibleServerVirtualEndpoint # 只读副本端点

核心工作流

1. 创建 PostgreSQL 灵活服务器

csharp
using System;
using Azure.ResourceManager.PostgreSql.FlexibleServers;
using Azure.ResourceManager.PostgreSql.FlexibleServers.Models;

ResourceGroupResource resourceGroup = await client
.GetDefaultSubscriptionAsync()
.Result
.GetResourceGroupAsync("my-resource-group");

PostgreSqlFlexibleServerCollection servers = resourceGroup.GetPostgreSqlFlexibleServers();

PostgreSqlFlexibleServerData data = new PostgreSqlFlexibleServerData(AzureLocation.EastUS)
{
Sku = new PostgreSqlFlexibleServerSku("Standard_D2ds_v4", PostgreSqlFlexibleServerSkuTier.GeneralPurpose),
AdministratorLogin = "pgadmin",
AdministratorLoginPassword = Environment.GetEnvironmentVariable("POSTGRES_ADMIN_PASSWORD") ?? throw new InvalidOperationException("POSTGRES_ADMIN_PASSWORD is required"),
Version = PostgreSqlFlexibleServerVersion.Ver16,
Storage = new PostgreSqlFlexibleServerStorage
{
StorageSizeInGB = 128,
AutoGrow = StorageAutoGrow.Enabled,
Tier = PostgreSqlStorageTierName.P30
},
Backup = new PostgreSqlFlexibleServerBackupProperties
{
BackupRetentionDays = 7,
GeoRedundantBackup = PostgreSqlFlexibleServerGeoRedundantBackupEnum.Disabled
},
HighAvailability = new PostgreSqlFlexibleServerHighAvailability
{
Mode = PostgreSqlFlexibleServerHighAvailabilityMode.ZoneRedundant,
StandbyAvailabilityZone = "2"
},
AvailabilityZone = "1",
AuthConfig = new PostgreSqlFlexibleServerAuthConfig
{
ActiveDirectoryAuth = PostgreSqlFlexibleServerActiveDirectoryAuthEnum.Enabled,
PasswordAuth = PostgreSqlFlexibleServerPasswordAuthEnum.Enabled
}
};

ArmOperation<PostgreSqlFlexibleServerResource> operation = await servers
.


CreateOrUpdateAsync(WaitUntil.Completed, "my-postgresql-server", data);

PostgreSqlFlexibleServerResource server = operation.Value;
Console.WriteLine($"Server created: {server.Data.FullyQualifiedDomainName}");

code
### 2. 创建数据库
csharp
PostgreSqlFlexibleServerResource server = await resourceGroup
.GetPostgreSqlFlexibleServerAsync("my-postgresql-server");

PostgreSqlFlexibleServerDatabaseCollection databases = server.GetPostgreSqlFlexibleServerDatabases();

PostgreSqlFlexibleServerDatabaseData dbData = new PostgreSqlFlexibleServerDatabaseData
{
Charset = "UTF8",
Collation = "en_US.utf8"
};

ArmOperation<PostgreSqlFlexibleServerDatabaseResource> operation = await databases
.CreateOrUpdateAsync(WaitUntil.Completed, "myappdb", dbData);

PostgreSqlFlexibleServerDatabaseResource database = operation.Value;
Console.WriteLine($"Database created: {database.Data.Name}");

code
### 3. 配置防火墙规则
csharp
PostgreSqlFlexibleServerFirewallRuleCollection firewallRules = server.GetPostgreSqlFlexibleServerFirewallRules();

// 允许特定的 IP 范围
PostgreSqlFlexibleServerFirewallRuleData ruleData = new PostgreSqlFlexibleServerFirewallRuleData
{
StartIPAddress = System.Net.IPAddress.Parse("10.0.0.1"),
EndIPAddress = System.Net.IPAddress.Parse("10.0.0.255")
};

ArmOperation<PostgreSqlFlexibleServerFirewallRuleResource> operation = await firewallRules
.CreateOrUpdateAsync(WaitUntil.Completed, "allow-internal", ruleData);

// 允许 Azure 服务
PostgreSqlFlexibleServerFirewallRuleData azureServicesRule = new PostgreSqlFlexibleServerFirewallRuleData
{
StartIPAddress = System.Net.IPAddress.Parse("0.0.0.0"),
EndIPAddress = System.Net.IPAddress.Parse("0.0.0.0")
};

await firewallRules.CreateOrUpdateAsync(WaitUntil.Completed, "AllowAllAzureServicesAndResourcesWithinAzureIps", azureServicesRule);

code
### 4. 更新服务器配置
csharp
PostgreSqlFlexibleServerConfigurationCollection configurations = server.GetPostgreSqlFlexibleServerConfigurations();

// 获取当前配置
PostgreSqlFlexibleServerConfigurationResource config = await configurations
.GetAsync("max_connections");

// 更新配置
PostgreSqlFlexibleServerConfigurationData configData = new PostgreSqlFlexibleServerConfigurationData
{
Value = "500",
Source = "user-override"
};

ArmOperation<PostgreSqlFlexibleServerConfigurationResource> operation = await configurations
.CreateOrUpdateAsync(WaitUntil.Completed, "max_connections", configData);

// 常用的 PostgreSQL 调优配置参数
string[] commonParams = {
"max_connections",
"shared_buffers",
"work_mem",
"maintenance_work_mem",
"effective_cache_size",
"log_min_duration_statement"
};

code
### 5. 配置 Entra ID 管理员
csharp
PostgreSqlFlexibleServerActiveDirectoryAdministratorCollection admins =
server.GetPostgreSqlFlexibleServerActiveDirectoryAdministrators();

PostgreSqlFlexibleServerActiveDirectoryAdministratorData adminData =
new PostgreSqlFlexibleServerActiveDirectoryAdministratorData
{
PrincipalType = PostgreSqlFlexibleServerPrincipalType.User,
PrincipalName = "[email protected]",
TenantId = Guid.Parse("<tenant-id>")
};

ArmOperation<PostgreSqlFlexibleServerActiveDirectoryAdministratorResource> operation = await admins
.CreateOrUpdateAsync(WaitUntil.Completed, "<entra-object-id>", adminData);

code
### 6. 列出并管理服务器
csharp
// 列出资源组中的服务器
code
e group
await foreach (PostgreSqlFlexibleServerResource server in resourceGroup.GetPostgreSqlFlexibleServers())
{
Console.WriteLine($"Server: {server.Data.Name}");
Console.WriteLine($" FQDN: {server.Data.FullyQualifiedDomainName}");
Console.WriteLine($" Version: {server.Data.Version}");
Console.WriteLine($" State: {server.Data.State}");
Console.WriteLine($" SKU: {server.Data.Sku.Name} ({server.Data.Sku.Tier})");
Console.WriteLine($" HA: {server.Data.HighAvailability?.Mode}");
}

// 列出服务器中的数据库
await foreach (PostgreSqlFlexibleServerDatabaseResource db in server.GetPostgreSqlFlexibleServerDatabases())
{
Console.WriteLine($"Database: {db.Data.Name}");
}

7. 备份与时间点还原

csharp
// 列出可用备份
await foreach (PostgreSqlFlexibleServerBackupResource backup in server.GetPostgreSqlFlexibleServerBackups())
{
    Console.WriteLine($"Backup: {backup.Data.Name}");
    Console.WriteLine($"  Type: {backup.Data.BackupType}");
    Console.WriteLine($"  Completed: {backup.Data.CompletedOn}");
}

// 时间点还原
PostgreSqlFlexibleServerData restoreData = new PostgreSqlFlexibleServerData(AzureLocation.EastUS)
{
CreateMode = PostgreSqlFlexibleServerCreateMode.PointInTimeRestore,
SourceServerResourceId = server.Id,
PointInTimeUtc = DateTimeOffset.UtcNow.AddHours(-2)
};

ArmOperation<PostgreSqlFlexibleServerResource> operation = await servers
.CreateOrUpdateAsync(WaitUntil.Completed, "my-postgresql-restored", restoreData);

8. 创建读取副本

csharp
PostgreSqlFlexibleServerData replicaData = new PostgreSqlFlexibleServerData(AzureLocation.WestUS)
{
    CreateMode = PostgreSqlFlexibleServerCreateMode.Replica,
    SourceServerResourceId = server.Id,
    Sku = new PostgreSqlFlexibleServerSku("Standard_D2ds_v4", PostgreSqlFlexibleServerSkuTier.GeneralPurpose)
};

ArmOperation<PostgreSqlFlexibleServerResource> operation = await servers
.CreateOrUpdateAsync(WaitUntil.Completed, "my-postgresql-replica", replicaData);

9. 停止与启动服务器

csharp
PostgreSqlFlexibleServerResource server = await resourceGroup
    .GetPostgreSqlFlexibleServerAsync("my-postgresql-server");

// 停止服务器(在不使用时节省成本)
await server.StopAsync(WaitUntil.Completed);

// 启动服务器
await server.StartAsync(WaitUntil.Completed);

// 重启服务器
await server.RestartAsync(WaitUntil.Completed, new PostgreSqlFlexibleServerRestartParameter
{
RestartWithFailover = true,
FailoverMode = PostgreSqlFlexibleServerFailoverMode.PlannedFailover
});

10. 更新服务器(扩缩容)

csharp
PostgreSqlFlexibleServerResource server = await resourceGroup
    .GetPostgreSqlFlexibleServerAsync("my-postgresql-server");

PostgreSqlFlexibleServerPatch patch = new PostgreSqlFlexibleServerPatch
{
Sku = new PostgreSqlFlexibleServerSku("Standard_D4ds_v4", PostgreSqlFlexibleServerSkuTier.GeneralPurpose),
Storage = new PostgreSqlFlexibleServerStorage
{
StorageSizeInGB = 256,
Tier = PostgreSqlStorageTierName.P40
}
};

ArmOperation<PostgreSqlFlexibleServerResource> operation = await server
.UpdateAsync(WaitUntil.Completed, patch);

11. 删除服务器

csharp
PostgreSqlFlexibleServerResource server = await resourceGroup
    .GetPostgreSqlFlexibleServerAsync("my-postgresql-server");

await server.DeleteAsync(WaitUntil.Completed);

关键类型参考

| 类型 | 用途 |
|------|---------|
| Pos_ | (此处文本截断) |
|
PostgreSqlFlexibleServerResource | 灵活服务器实例 |
|
PostgreSqlFlexibleServerData | 服务器配置数据 |
|
PostgreSqlFlexibleServerCollection | 服务器集合 |
|
PostgreSqlFlexibleServerDatabaseResource | 服务器内的数据库 |
|
PostgreSqlFlexibleServerFirewallRuleResource | IP 防火墙规则 |
|
PostgreSqlFlexibleServerConfigurationResource | 服务器参数 |
|
PostgreSqlFlexibleServerBackupResource | 备份元数据 |
|
PostgreSqlFlexibleServerActiveDirectoryAdministratorResource | Entra ID 管理员 |
|
PostgreSqlFlexibleServerSku | SKU(计算层级 + 尺寸) |
|
PostgreSqlFlexibleServerStorage | 存储配置 |
|
PostgreSqlFlexibleServerHighAvailability | 高可用性 (HA) 配置 |
|
PostgreSqlFlexibleServerBackupProperties | 备份设置 |
|
PostgreSqlFlexibleServerAuthConfig | 身份验证设置 |

SKU 层级

| 层级 | 使用场景 | SKU 示例 |
|------|----------|--------------|
|
Burstable | 开发/测试,轻量级工作负载 | Standard_B1ms, Standard_B2s |
|
GeneralPurpose | 生产工作负载 | Standard_D2ds_v4, Standard_D4ds_v4 |
|
MemoryOptimized | 高内存需求 | Standard_E2ds_v4, Standard_E4ds_v4 |

PostgreSQL 版本

| 版本 | 枚举值 |
|---------|------------|
| PostgreSQL 11 |
Ver11 |
| PostgreSQL 12 |
Ver12 |
| PostgreSQL 13 |
Ver13 |
| PostgreSQL 14 |
Ver14 |
| PostgreSQL 15 |
Ver15 |
| PostgreSQL 16 |
Ver16 |

高可用性模式

| 模式 | 描述 |
|------|-------------|
|
Disabled | 无高可用性(单服务器) |
|
SameZone | 同一可用区内的高可用性 |
|
ZoneRedundant | 跨可用区的高可用性 |

最佳实践

1. 使用灵活服务器 — 单一服务器 (Single Server) 已弃用
2. 启用可用区冗余 HA — 适用于生产工作负载
3. 使用 DefaultAzureCredential — 优先于连接字符串
4. 配置 Entra ID 身份验证 — 比单纯的 SQL 验证更安全
5. 启用两种验证方式 — Entra ID + 密码,以提高灵活性
6. 设置合适的备份保留期 — 根据合规要求设置 7-35 天
7. 使用私有端点 — 实现安全的网络访问
8. 调优服务器参数 — 根据工作负载特性进行调整
9. 使用只读副本 — 适用于读密集型工作负载
10. 停止开发/测试服务器 — 不使用时关闭以节省成本

错误处理

csharp
using Azure;

try
{
ArmOperation<PostgreSqlFlexibleServerResource> operation = await servers
.CreateOrUpdateAsync(WaitUntil.Completed, "my-postgresql", data);
}
catch (RequestFailedException ex) when (ex.Status == 409)
{
Console.WriteLine("Server already exists");
}
catch (RequestFailedException ex) when (ex.Status == 400)
{
Console.WriteLine($"Invalid configuration: {ex.Message}");
}
catch (RequestFailedException ex)
{
Console.WriteLine($"Azure error: {ex.Status} - {ex.Message}");
}

连接字符串

创建服务器后,使用以下方式连接:

csharp
// Npgsql 连接字符串
string connectionString = $"Host={server.Data.FullyQualifiedDomainName};" +
    "Database=myappdb;" +
    "Username=pgadmin;" +
    "Password=YourSecurePassword123!;" +
    "SSL Mode=Require;Trust Server Certificate=true;";

// 使用 Entra ID 令牌(推荐)
var credential = new DefaultAzureCredential();
var token = await credential.GetTokenAsync(
new TokenRequestContext(new[] { "https://ossrdbms-aad.database.windows.net/.default" }));

string connectionString = $"Host={server.Data.FullyQualifiedDomainName};" +
"Database=mya


ppdb;" +
$"[email protected];" +
$"Password={token.Token};" +
"SSL Mode=Require;";
`

相关 SDK

| SDK | 用途 | 安装命令 |
|-----|---------|---------|
|
Azure.ResourceManager.PostgreSql | PostgreSQL 管理(本 SDK) | dotnet add package Azure.ResourceManager.PostgreSql |
|
Azure.ResourceManager.MySql | MySQL 管理 | dotnet add package Azure.ResourceManager.MySql |
|
Npgsql | PostgreSQL 数据访问 | dotnet add package Npgsql |
|
Npgsql.EntityFrameworkCore.PostgreSQL | EF Core 提供程序 | dotnet add package Npgsql.EntityFrameworkCore.PostgreSQL` |

参考链接

| 资源 | URL |
|----------|-----|
| NuGet 包 | https://www.nuget.org/packages/Azure.ResourceManager.PostgreSql |
| API 参考 | https://learn.microsoft.com/dotnet/api/azure.resourcemanager.postgresql |
| 产品文档 | https://learn.microsoft.com/azure/postgresql/flexible-server/ |
| GitHub 源码 | https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/postgresql/Azure.ResourceManager.PostgreSql |

使用场景

本技能适用于执行概览中所描述的工作流或操作。

局限性

  • 仅在任务明确符合上述范围时使用本技能。
  • 不要将输出结果视为针对特定环境的验证、测试或专家评审的替代方案。
  • 如果缺少必要的输入、权限、安全边界或成功标准,请停止操作并请求澄清。