Azure Resource Manager Postgresql Dotnet

作者 microsoft354361d83247MIT3K 個星標收錄於 2026年10月8日更新於 2026年10月8日儲存庫今天更新

Azure PostgreSQL Flexible Server SDK for .NET. Database management for PostgreSQL Flexible Server deployments. Use for creating servers, databases, firewall rules, configurations, backups, and high availability. Triggers: "PostgreSQL", "PostgreSqlFlexibleServer", "PostgreSQL Flexible Server", "Azure Database for PostgreSQL", "PostgreSQL database management", "PostgreSQL firewall", "PostgreSQL backup", "Postgres".

AI 產生的概覽

指導使用 .NET 透過 Azure Resource Manager SDK 管理 Azure PostgreSQL 彈性伺服器資源。

功能
提供 C# 程式碼範例,用於透過 Azure.ResourceManager.PostgreSql SDK 佈建與操作 Azure Database for PostgreSQL 彈性伺服器。內容涵蓋伺服器與資料庫建立、防火牆規則、伺服器參數調校、Entra ID 管理員、備份與時間點還原、唯讀複本、高可用性、擴縮、啟動停止以及刪除。也列出關鍵 SDK 型別、SKU 層級、支援的 PostgreSQL 版本和連接字串寫法。
適用情境
適用於撰寫或審查管理 Azure PostgreSQL 彈性伺服器部署的 .NET 程式碼,例如建立伺服器、資料庫、防火牆規則或備份。也適合設定這些伺服器的高可用性、唯讀複本或 Entra ID 驗證。
執行需求
需要 .NET SDK 以及 Azure.ResourceManager.PostgreSql 和 Azure.Identity NuGet 套件,並需要 Azure 認證與 Azure 訂用帳戶。使用訂用帳戶 ID、資源群組和伺服器名稱等環境變數,且需要連線至 Azure 的網路。不包含指令碼。

Azure.ResourceManager.PostgreSql (.NET)

Azure Resource Manager SDK for managing PostgreSQL Flexible Server deployments.

Installation

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

Current Version: v1.2.0 (GA)
API Version: 2023-12-01-preview

Note: This skill focuses on PostgreSQL Flexible Server. Single Server is deprecated and scheduled for retirement.

Environment Variables

bash
AZURE_SUBSCRIPTION_ID=<your-subscription-id>  # Required: Azure subscription IDAZURE_RESOURCE_GROUP=<your-resource-group>  # Required: resource group nameAZURE_POSTGRESQL_SERVER_NAME=<your-postgresql-server>  # Required: PostgreSQL Flexible Server nameAZURE_TOKEN_CREDENTIALS=prod  # Required only if DefaultAzureCredential is used in production

Authentication

csharp
using Azure.Identity;using Azure.ResourceManager;using Azure.ResourceManager.PostgreSql;using Azure.ResourceManager.PostgreSql.FlexibleServers;
// Local dev: DefaultAzureCredential. Production: set AZURE_TOKEN_CREDENTIALS=prod or AZURE_TOKEN_CREDENTIALS=<specific_credential>var credential = new DefaultAzureCredential(    DefaultAzureCredential.DefaultEnvironmentVariableName);// Or use a specific credential directly in production:// See https://learn.microsoft.com/dotnet/api/overview/azure/identity-readme?view=azure-dotnet#credential-classes// var credential = new ManagedIdentityCredential();ArmClient client = new ArmClient(credential);

Resource Hierarchy

Subscription└── ResourceGroup    └── PostgreSqlFlexibleServer              # PostgreSQL Flexible Server instance        ├── PostgreSqlFlexibleServerDatabase  # Database within the server        ├── PostgreSqlFlexibleServerFirewallRule # IP firewall rules        ├── PostgreSqlFlexibleServerConfiguration # Server parameters        ├── PostgreSqlFlexibleServerBackup    # Backup information        ├── PostgreSqlFlexibleServerActiveDirectoryAdministrator # Entra ID admin        └── PostgreSqlFlexibleServerVirtualEndpoint # Read replica endpoints

Core Workflows

1. Create PostgreSQL Flexible Server

csharp
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 = "YourSecurePassword123!",    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}");

2. Create Database

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}");

3. Configure Firewall Rules

csharp
PostgreSqlFlexibleServerFirewallRuleCollection firewallRules = server.GetPostgreSqlFlexibleServerFirewallRules();
// Allow specific IP rangePostgreSqlFlexibleServerFirewallRuleData 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);
// Allow Azure servicesPostgreSqlFlexibleServerFirewallRuleData 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);

4. Update Server Configuration

csharp
PostgreSqlFlexibleServerConfigurationCollection configurations = server.GetPostgreSqlFlexibleServerConfigurations();
// Get current configurationPostgreSqlFlexibleServerConfigurationResource config = await configurations    .GetAsync("max_connections");
// Update configurationPostgreSqlFlexibleServerConfigurationData configData = new PostgreSqlFlexibleServerConfigurationData{    Value = "500",    Source = "user-override"};
ArmOperation<PostgreSqlFlexibleServerConfigurationResource> operation = await configurations    .CreateOrUpdateAsync(WaitUntil.Completed, "max_connections", configData);
// Common PostgreSQL configurations to tunestring[] commonParams = {     "max_connections",     "shared_buffers",     "work_mem",     "maintenance_work_mem",    "effective_cache_size",    "log_min_duration_statement"};

5. Configure Entra ID Administrator

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);

6. List and Manage Servers

csharp
// List servers in resource groupawait 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}");}
// List databases in serverawait foreach (PostgreSqlFlexibleServerDatabaseResource db in server.GetPostgreSqlFlexibleServerDatabases()){    Console.WriteLine($"Database: {db.Data.Name}");}

7. Backup and Point-in-Time Restore

csharp
// List available backupsawait foreach (PostgreSqlFlexibleServerBackupResource backup in server.GetPostgreSqlFlexibleServerBackups()){    Console.WriteLine($"Backup: {backup.Data.Name}");    Console.WriteLine($"  Type: {backup.Data.BackupType}");    Console.WriteLine($"  Completed: {backup.Data.CompletedOn}");}
// Point-in-time restorePostgreSqlFlexibleServerData 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. Create Read Replica

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. Stop and Start Server

csharp
PostgreSqlFlexibleServerResource server = await resourceGroup    .GetPostgreSqlFlexibleServerAsync("my-postgresql-server");
// Stop server (saves costs when not in use)await server.StopAsync(WaitUntil.Completed);
// Start serverawait server.StartAsync(WaitUntil.Completed);
// Restart serverawait server.RestartAsync(WaitUntil.Completed, new PostgreSqlFlexibleServerRestartParameter{    RestartWithFailover = true,    FailoverMode = PostgreSqlFlexibleServerFailoverMode.PlannedFailover});

10. Update Server (Scale)

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. Delete Server

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

Key Types Reference

TypePurpose
PostgreSqlFlexibleServerResourceFlexible Server instance
PostgreSqlFlexibleServerDataServer configuration data
PostgreSqlFlexibleServerCollectionCollection of servers
PostgreSqlFlexibleServerDatabaseResourceDatabase within server
PostgreSqlFlexibleServerFirewallRuleResourceIP firewall rule
PostgreSqlFlexibleServerConfigurationResourceServer parameter
PostgreSqlFlexibleServerBackupResourceBackup metadata
PostgreSqlFlexibleServerActiveDirectoryAdministratorResourceEntra ID admin
PostgreSqlFlexibleServerSkuSKU (compute tier + size)
PostgreSqlFlexibleServerStorageStorage configuration
PostgreSqlFlexibleServerHighAvailabilityHA configuration
PostgreSqlFlexibleServerBackupPropertiesBackup settings
PostgreSqlFlexibleServerAuthConfigAuthentication settings

SKU Tiers

TierUse CaseSKU Examples
BurstableDev/test, light workloadsStandard_B1ms, Standard_B2s
GeneralPurposeProduction workloadsStandard_D2ds_v4, Standard_D4ds_v4
MemoryOptimizedHigh memory requirementsStandard_E2ds_v4, Standard_E4ds_v4

PostgreSQL Versions

VersionEnum Value
PostgreSQL 11Ver11
PostgreSQL 12Ver12
PostgreSQL 13Ver13
PostgreSQL 14Ver14
PostgreSQL 15Ver15
PostgreSQL 16Ver16

High Availability Modes

ModeDescription
DisabledNo HA (single server)
SameZoneHA within same availability zone
ZoneRedundantHA across availability zones

Best Practices

  1. Use Flexible Server — Single Server is deprecated
  2. Enable zone-redundant HA — For production workloads
  3. Use DefaultAzureCredential — Prefer over connection strings
  4. Configure Entra ID authentication — More secure than SQL auth alone
  5. Enable both auth methods — Entra ID + password for flexibility
  6. Set appropriate backup retention — 7-35 days based on compliance
  7. Use private endpoints — For secure network access
  8. Tune server parameters — Based on workload characteristics
  9. Use read replicas — For read-heavy workloads
  10. Stop dev/test servers — Save costs when not in use

Error Handling

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}");}

Connection String

After creating the server, connect using:

csharp
// Npgsql connection stringstring connectionString = $"Host={server.Data.FullyQualifiedDomainName};" +    "Database=myappdb;" +    "Username=pgadmin;" +    "Password=YourSecurePassword123!;" +    "SSL Mode=Require;Trust Server Certificate=true;";
// With Entra ID token (recommended)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=myappdb;" +    $"[email protected];" +    $"Password={token.Token};" +    "SSL Mode=Require;";

Related SDKs

SDKPurposeInstall
Azure.ResourceManager.PostgreSqlPostgreSQL management (this SDK)dotnet add package Azure.ResourceManager.PostgreSql
Azure.ResourceManager.MySqlMySQL managementdotnet add package Azure.ResourceManager.MySql
NpgsqlPostgreSQL data accessdotnet add package Npgsql
Npgsql.EntityFrameworkCore.PostgreSQLEF Core providerdotnet add package Npgsql.EntityFrameworkCore.PostgreSQL

Reference Links

來源與署名

來源:microsoft/skills位於.github/plugins/azure-sdk-dotnet/skills/azure-resource-manager-postgresql-dotnet提交354361d

授權條款: MIT

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架