azure-resource-manager-sql-dotnet

随附的上游支持文件

支持文件位于相对于技能的路径中。有关其固定来源、许可证、哈希值和导入变更，请参阅 UPSTREAM-NOTICE.md。

Azure.ResourceManager.Sql（.NET）

用于通过 Azure Resource Manager 预配和管理 Azure SQL 资源的管理平面 SDK。

⚠️ 管理平面与数据平面

• 此 SDK（Azure.ResourceManager.Sql）：创建服务器、数据库和弹性池，配置防火墙规则，管理故障转移组
• 数据平面 SDK（Microsoft.Data.SqlClient）：执行查询和存储过程，管理连接

安装

dotnet add package Azure.ResourceManager.Sql
dotnet add package Azure.Identity

版本边界： 以下片段仅供说明，并非可编译的项目。进行适配前，请固定所需的 SDK 版本，并查阅其 API 参考和区域 SKU 可用性；此处未声明任何当前版本。

环境变量

AZURE_SUBSCRIPTION_ID=<your-subscription-id>
# For service principal auth (optional)
AZURE_TENANT_ID=<tenant-id>
AZURE_CLIENT_ID=<client-id>
AZURE_CLIENT_SECRET=<client-secret>

身份验证

using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Sql;

// Always use DefaultAzureCredential
var credential = new DefaultAzureCredential();
var armClient = new ArmClient(credential);

// Get subscription
var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID");
var subscription = armClient.GetSubscriptionResource(
    new ResourceIdentifier($"/subscriptions/{subscriptionId}"));

资源层次结构

ArmClient
└── SubscriptionResource
    └── ResourceGroupResource
        └── SqlServerResource
            ├── SqlDatabaseResource
            ├── ElasticPoolResource
            │   └── ElasticPoolDatabaseResource
            ├── SqlFirewallRuleResource
            ├── FailoverGroupResource
            ├── ServerBlobAuditingPolicyResource
            ├── EncryptionProtectorResource
            └── VirtualNetworkRuleResource

核心工作流

执行任何写入操作前，请确认订阅、租户、资源组、确切目标、SKU 预算和生产环境变更范围。读取当前状态，并根据固定的 SDK 采用适当的更新／修补语义；精简的 CreateOrUpdate 负载并不能证明未指定的设置会得到保留。管理平面身份验证不会授予 SQL 数据平面访问权限。请勿记录密码、连接字符串或存储密钥。专用网络需要设置终结点、DNS 和路由；仅禁用公共访问并不能建立连接。

1. 创建 SQL 服务器

using System;
using Azure.ResourceManager.Sql;
using Azure.ResourceManager.Sql.Models;

// Get resource group
var resourceGroup = await subscription
    .GetResourceGroupAsync("my-resource-group");

// Define server
var serverData = new SqlServerData(AzureLocation.EastUS)
{
    AdministratorLogin = "sqladmin",
    AdministratorLoginPassword = Environment.GetEnvironmentVariable("SQL_ADMIN_PASSWORD") ?? throw new InvalidOperationException("SQL_ADMIN_PASSWORD is required"),
    Version = "12.0",
    MinimalTlsVersion = SqlMinimalTlsVersion.Tls1_2,
    PublicNetworkAccess = ServerNetworkAccessFlag.Disabled // configure approved private endpoint and DNS separately
};

// Create server (long-running operation)
var serverCollection = resourceGroup.Value.GetSqlServers();
var operation = await serverCollection.CreateOrUpdateAsync(
    WaitUntil.Completed,
    "my-sql-server",
    serverData);

SqlServerResource server = operation.Value;

2. 创建 SQL 数据库

var databaseData = new SqlDatabaseData(AzureLocation.EastUS)
{
    Sku = new SqlSku("S0") { Tier = "Standard" },
    MaxSizeBytes = 2L * 1024 * 1024 * 1024, // 2 GB
    Collation = "SQL_Latin1_General_CP1_CI_AS",
    RequestedBackupStorageRedundancy = SqlBackupStorageRedundancy.Local
};

var databaseCollection = server.GetSqlDatabases();
var dbOperation = await databaseCollection.CreateOrUpdateAsync(
    WaitUntil.Completed,
    "my-database",
    databaseData);

SqlDatabaseResource database = dbOperation.Value;

3. 创建弹性池

var poolData = new ElasticPoolData(AzureLocation.EastUS)
{
    Sku = new SqlSku("StandardPool")
    {
        Tier = "Standard",
        Capacity = 100 // 100 eDTUs
    },
    PerDatabaseSettings = new ElasticPoolPerDatabaseSettings
    {
        MinCapacity = 0,
        MaxCapacity = 100
    }
};

var poolCollection = server.GetElasticPools();
var poolOperation = await poolCollection.CreateOrUpdateAsync(
    WaitUntil.Completed,
    "my-elastic-pool",
    poolData);

ElasticPoolResource pool = poolOperation.Value;

4. 将数据库添加到弹性池

var databaseData = new SqlDatabaseData(AzureLocation.EastUS)
{
    ElasticPoolId = pool.Id
};

await databaseCollection.CreateOrUpdateAsync(
    WaitUntil.Completed,
    "pooled-database",
    databaseData);

5. 配置防火墙规则

// OPTIONAL broad exception: 0.0.0.0 permits connections from Azure services
// outside this subscription too; it is not a tenant-only firewall rule. Do not
// apply by default. With public access disabled these rules do not enable it.
// Allow Azure services
var azureServicesRule = new SqlFirewallRuleData
{
    StartIPAddress = "0.0.0.0",
    EndIPAddress = "0.0.0.0"
};

var firewallCollection = server.GetSqlFirewallRules();
await firewallCollection.CreateOrUpdateAsync(
    WaitUntil.Completed,
    "AllowAzureServices",
    azureServicesRule);

// Allow specific IP range
var clientRule = new SqlFirewallRuleData
{
    StartIPAddress = "203.0.113.0",
    EndIPAddress = "203.0.113.255"
};

await firewallCollection.CreateOrUpdateAsync(
    WaitUntil.Completed,
    "AllowClientIPs",
    clientRule);

6. 列出资源

// List all servers in subscription
await foreach (var srv in subscription.GetSqlServersAsync())
{
    Console.WriteLine($"Server: {srv.Data.Name} in {srv.Data.Location}");
}

// List databases in a server
await foreach (var db in server.GetSqlDatabases())
{
    Console.WriteLine($"Database: {db.Data.Name}, SKU: {db.Data.Sku?.Name}");
}

// List elastic pools
await foreach (var ep in server.GetElasticPools())
{
    Console.WriteLine($"Pool: {ep.Data.Name}, DTU: {ep.Data.Sku?.Capacity}");
}

7. 获取连接字符串

// Use returned FQDN; sovereign cloud suffixes can differ.
var serverFqdn = server.Data.FullyQualifiedDomainName;
var connectionString = $"Server=tcp:{serverFqdn},1433;" +
    $"Initial Catalog={database.Data.Name};" +
    "Persist Security Info=False;" +
    $"User ID={server.Data.AdministratorLogin};" +
    "Password=<your-password>;" +
    "MultipleActiveResultSets=False;" +
    "Encrypt=True;" +
    "TrustServerCertificate=False;" +
    "Connection Timeout=30;";

关键类型参考

类型	用途
ArmClient	所有 ARM 操作的入口
SqlServerResource	表示 Azure SQL 服务器
SqlServerCollection	服务器 CRUD 集合
SqlDatabaseResource	表示 SQL 数据库
SqlDatabaseCollection	数据库 CRUD 集合
ElasticPoolResource	表示弹性池
ElasticPoolCollection	弹性池 CRUD 集合
SqlFirewallRuleResource	表示防火墙规则
SqlFirewallRuleCollection	防火墙规则 CRUD 集合
SqlServerData	服务器创建／更新负载
SqlDatabaseData	数据库创建／更新负载
ElasticPoolData	弹性池创建／更新负载
SqlFirewallRuleData	防火墙规则创建／更新负载
SqlSku	SKU 配置（层级、容量）

常见 SKU

数据库 SKU

SKU 名称	层级	描述
Basic	Basic	5 DTU，最大 2 GB
S0-S12	Standard	10-3000 DTU
P1-P15	Premium	125-4000 DTU
GP_Gen5_2	GeneralPurpose	基于 vCore，2 个 vCore
BC_Gen5_2	BusinessCritical	基于 vCore，2 个 vCore
HS_Gen5_2	Hyperscale	基于 vCore，2 个 vCore

弹性池 SKU

SKU 名称	层级	描述
BasicPool	Basic	50-1600 eDTU
StandardPool	Standard	50-3000 eDTU
PremiumPool	Premium	125-4000 eDTU
GP_Gen5_2	GeneralPurpose	基于 vCore
BC_Gen5_2	BusinessCritical	基于 vCore

最佳实践

1. 对于必须完成后才能继续的操作，请使用 WaitUntil.Completed
2. 需要手动轮询或并行运行操作时，请使用 WaitUntil.Started
3. 始终使用 DefaultAzureCredential — 在生产环境中绝不要将密码硬编码
4. 处理 RequestFailedException，以应对 ARM API 错误
5. 使用 CreateOrUpdateAsync 实现幂等操作
6. 通过 Get* 方法遍历层次结构（例如，server.GetSqlDatabases()）
7. 管理多个数据库时，使用弹性池优化成本
8. 尝试连接前，请先配置防火墙规则

错误处理

using Azure;

try
{
    var operation = await serverCollection.CreateOrUpdateAsync(
        WaitUntil.Completed, serverName, serverData);
}
catch (RequestFailedException ex) when (ex.Status == 409)
{
    Console.WriteLine($"Conflict: {ex.ErrorCode}; inspect the resource and operation state");
    throw; // 409 does not necessarily mean an existing matching server
}
catch (RequestFailedException ex) when (ex.Status == 400)
{
    Console.WriteLine($"Invalid request: {ex.Message}");
}
catch (RequestFailedException ex)
{
    Console.WriteLine($"ARM Error: {ex.Status} - {ex.ErrorCode}: {ex.Message}");
}

参考文件

文件	阅读时机
references/server-management.md	服务器 CRUD、管理员凭据、Azure AD 身份验证、网络
references/database-operations.md	数据库 CRUD、扩展、备份、还原、复制
references/elastic-pools.md	池管理、添加／删除数据库、扩展

相关 SDK

SDK	用途	安装
Microsoft.Data.SqlClient	数据平面（执行查询、存储过程）	dotnet add package Microsoft.Data.SqlClient
Azure.ResourceManager.Sql	管理平面（此 SDK）	dotnet add package Azure.ResourceManager.Sql
Microsoft.EntityFrameworkCore.SqlServer	SQL Server 的 ORM	dotnet add package Microsoft.EntityFrameworkCore.SqlServer

适用场景

当需要执行概述中描述的工作流或操作时，可使用此技能。

限制

• 仅当任务明确符合上述范围时，才使用此技能。
• 不要将输出视为针对特定环境的验证、测试或专家审查的替代品。
• 如果缺少必需的输入、权限、安全边界或成功标准，请暂停并请求澄清。