Azure 资源管理器 SQL .NET

azure-resource-manager-sql-dotnet

分类通用

作者Agentic Awesome Skills 社区

许可MIT

评分4.60/5

使用8.5K

Azure.ResourceManager.Sql (.NET)

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

> ⚠️ 管理平面 vs 数据平面
> - 本 SDK (Azure.ResourceManager.Sql)：创建服务器、数据库、弹性池，配置防火墙规则，管理故障转移组。
> - 数据平面 SDK (Microsoft.Data.SqlClient)：执行查询、存储过程，管理连接。

安装

bash

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

当前版本：稳定版 v1.3.0，预览版 v1.4.0-beta.3

环境变量

bash

AZURE_SUBSCRIPTION_ID=<your-subscription-id>
用于服务主体身份验证（可选）
AZURE_TENANT_ID=<tenant-id>
AZURE_CLIENT_ID=<client-id>
AZURE_CLIENT_SECRET=<client-secret>

身份验证

csharp

using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Sql;
// 始终使用 DefaultAzureCredential
var credential = new DefaultAzureCredential();
var armClient = new ArmClient(credential);
// 获取订阅
var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID");
var subscription = armClient.GetSubscriptionResource(
    new ResourceIdentifier($"/subscriptions/{subscriptionId}"));

资源层级

code

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

核心工作流

1. 创建 SQL 服务器

csharp

using System;
using Azure.ResourceManager.Sql;
using Azure.ResourceManager.Sql.Models;
// 获取资源组
var resourceGroup = await subscription
    .GetResourceGroupAsync("my-resource-group");
// 定义服务器
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.Enabled
};
// 创建服务器（长时间运行的操作）
var serverCollection = resourceGroup.Value.GetSqlServers();
var operation = await serverCollection.CreateOrUpdateAsync(
    WaitUntil.Completed,
    "my-sql-server",
    serverData);
SqlServerResource server = operation.Value;

2. 创建 SQL 数据库

csharp

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. 创建弹性池

csharp

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;

code

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

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

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

code

### 5. 配置防火墙规则

csharp
// 允许 Azure 服务
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);

// 允许特定 IP 范围
var clientRule = new SqlFirewallRuleData
{
StartIPAddress = "203.0.113.0",
EndIPAddress = "203.0.113.255"
};

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

code

### 6. 列出资源

csharp
// 列出订阅中的所有服务器
await foreach (var srv in subscription.GetSqlServersAsync())
{
Console.WriteLine($"Server: {srv.Data.Name} in {srv.Data.Location}");
}

// 列出服务器中的数据库
await foreach (var db in server.GetSqlDatabases())
{
Console.WriteLine($"Database: {db.Data.Name}, SKU: {db.Data.Sku?.Name}");
}

// 列出弹性池
await foreach (var ep in server.GetElasticPools())
{
Console.WriteLine($"Pool: {ep.Data.Name}, DTU: {ep.Data.Sku?.Capacity}");
}

code

### 7. 获取连接字符串

csharp
// 构建连接字符串（服务器 FQDN 是可预测的）
var serverFqdn = $"{server.Data.Name}.database.windows.net";
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;";

code

## 关键类型参考
| 类型 | 用途 |
|------|---------|
| 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 DTUs, 最大 2 GB |
| S0-S12 | Standard | 10-3000 DTUs |
| P1-P15 | Premium | 125-4000 DTUs |
| GP_G | General Purpose | 通用目的 |
| GP_Gen5_2 | GeneralPurpose | 基于 vCore，2 vCores |
| BC_Gen5_2 | BusinessCritical | 基于 vCore，2 vCores |
| HS_Gen5_2 | Hyperscale | 基于 vCore，2 vCores |
弹性池 SKU
| SKU 名称 | 层级 | 描述 |
|----------|------|-------------|
| BasicPool | Basic | 50-1600 eDTUs |
| StandardPool | Standard | 50-3000 eDTUs |
| PremiumPool | Premium | 125-4000 eDTUs |
| 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. 在尝试连接之前配置防火墙规则
错误处理

csharp using Azure;

try
{
var operation = await serverCollection.CreateOrUpdateAsync(
WaitUntil.Completed, serverName, serverData);
}
catch (RequestFailedException ex) when (ex.Status == 409)
{
Console.WriteLine("Server already exists");
}
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` |

使用场景

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

局限性

仅在任务明确符合上述范围时使用此技能。

不要将输出视为环境特定验证、测试或专家评审的替代方案。

如果缺少必要的输入、权限、安全边界或成功标准，请停止并请求澄清。

Azure 资源管理器 SQL .NET

Azure.ResourceManager.Sql (.NET)

安装

环境变量

用于服务主体身份验证（可选）

身份验证

资源层级

核心工作流

1. 创建 SQL 服务器

2. 创建 SQL 数据库

3. 创建弹性池

常用 SKU

数据库 SKU

弹性池 SKU

最佳实践

`错误处理`

参考文件

相关 SDK

使用场景

局限性

扫码进交流群