Azure Resource Manager Sql Dotnet

作者 microsoft354361d83247MIT收录于 2026年10月8日更新于 2026年10月8日

Azure Resource Manager SDK for Azure SQL in .NET. Use for MANAGEMENT PLANE operations: creating/managing SQL servers, databases, elastic pools, firewall rules, and failover groups via Azure Resource Manager. NOT for data plane operations (executing queries) - use Microsoft.Data.SqlClient for that. Triggers: "SQL server", "create SQL database", "manage SQL resources", "ARM SQL", "SqlServerResource", "provision Azure SQL", "elastic pool", "firewall rule".

精选仅含说明DevOps & Cloud
AI 生成的概览

指导在 .NET 中通过 Azure Resource Manager 管理面预配 Azure SQL 服务器、数据库、弹性池、防火墙规则和故障转移组。

功能
该技能介绍用于 Azure SQL 管理面操作的 Azure.ResourceManager.Sql .NET SDK。内容涵盖创建和管理 SQL 服务器、数据库、弹性池、防火墙规则与故障转移组,列出资源、构造连接字符串以及处理 ARM 错误,并附有 SKU 表和最佳实践说明。它还指向服务器管理、数据库操作和弹性池三个参考文件。技能明确排除数据面的查询执行,并将其归入 Microsoft.Data.SqlClient。
适用场景
适用于在 .NET 中通过 Azure Resource Manager 预配或管理 Azure SQL 资源的场景,例如创建 SQL 服务器、数据库或弹性池,配置防火墙规则,或扩缩容和列出 SQL 资源。它不用于对数据库执行查询或存储过程。
运行要求
需要 .NET SDK 以及 Azure.ResourceManager.Sql 和 Azure.Identity NuGet 包、一个 Azure 订阅和相应凭据(DefaultAzureCredential,或通过 AZURE_SUBSCRIPTION_ID、AZURE_TENANT_ID、AZURE_CLIENT_ID 和 AZURE_CLIENT_SECRET 使用服务主体)。需要访问 Azure Resource Manager 的网络连接。不附带脚本,仅包含说明和三个参考 Markdown 文件。

Azure.ResourceManager.Sql (.NET)

Management plane SDK for provisioning and managing Azure SQL resources via Azure Resource Manager.

⚠️ Management vs Data Plane

  • This SDK (Azure.ResourceManager.Sql): Create servers, databases, elastic pools, configure firewall rules, manage failover groups
  • Data Plane SDK (Microsoft.Data.SqlClient): Execute queries, stored procedures, manage connections

Installation

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

Current Versions: Stable v1.3.0, Preview v1.4.0-beta.3

Environment Variables

bash
AZURE_SUBSCRIPTION_ID=<your-subscription-id>  # Required: Azure subscription IDAZURE_TOKEN_CREDENTIALS=prod  # Required only if DefaultAzureCredential is used in productionAZURE_TENANT_ID=<tenant-id>  # For service principal auth (optional)AZURE_CLIENT_ID=<client-id>  # For service principal auth (optional)AZURE_CLIENT_SECRET=<client-secret>  # For service principal auth (optional)

Authentication

csharp
using Azure.Identity;using Azure.ResourceManager;using Azure.ResourceManager.Sql;
// 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();var armClient = new ArmClient(credential);
// Get subscriptionvar subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID");var subscription = armClient.GetSubscriptionResource(    new ResourceIdentifier($"/subscriptions/{subscriptionId}"));

Resource Hierarchy

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

Core Workflow

1. Create SQL Server

csharp
using Azure.ResourceManager.Sql;using Azure.ResourceManager.Sql.Models;
// Get resource groupvar resourceGroup = await subscription    .GetResourceGroupAsync("my-resource-group");
// Define servervar serverData = new SqlServerData(AzureLocation.EastUS){    AdministratorLogin = "sqladmin",    AdministratorLoginPassword = "YourSecurePassword123!",    Version = "12.0",    MinimalTlsVersion = SqlMinimalTlsVersion.Tls1_2,    PublicNetworkAccess = ServerNetworkAccessFlag.Enabled};
// 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. Create SQL Database

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. Create Elastic Pool

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;

4. Add Database to Elastic Pool

csharp
var databaseData = new SqlDatabaseData(AzureLocation.EastUS){    ElasticPoolId = pool.Id};
await databaseCollection.CreateOrUpdateAsync(    WaitUntil.Completed,    "pooled-database",    databaseData);

5. Configure Firewall Rules

csharp
// Allow Azure servicesvar 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 rangevar clientRule = new SqlFirewallRuleData{    StartIPAddress = "203.0.113.0",    EndIPAddress = "203.0.113.255"};
await firewallCollection.CreateOrUpdateAsync(    WaitUntil.Completed,    "AllowClientIPs",    clientRule);

6. List Resources

csharp
// List all servers in subscriptionawait foreach (var srv in subscription.GetSqlServersAsync()){    Console.WriteLine($"Server: {srv.Data.Name} in {srv.Data.Location}");}
// List databases in a serverawait foreach (var db in server.GetSqlDatabases()){    Console.WriteLine($"Database: {db.Data.Name}, SKU: {db.Data.Sku?.Name}");}
// List elastic poolsawait foreach (var ep in server.GetElasticPools()){    Console.WriteLine($"Pool: {ep.Data.Name}, DTU: {ep.Data.Sku?.Capacity}");}

7. Get Connection String

csharp
// Build connection string (server FQDN is predictable)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;";

Key Types Reference

TypePurpose
ArmClientEntry point for all ARM operations
SqlServerResourceRepresents an Azure SQL server
SqlServerCollectionCollection for server CRUD
SqlDatabaseResourceRepresents a SQL database
SqlDatabaseCollectionCollection for database CRUD
ElasticPoolResourceRepresents an elastic pool
ElasticPoolCollectionCollection for elastic pool CRUD
SqlFirewallRuleResourceRepresents a firewall rule
SqlFirewallRuleCollectionCollection for firewall rule CRUD
SqlServerDataServer creation/update payload
SqlDatabaseDataDatabase creation/update payload
ElasticPoolDataElastic pool creation/update payload
SqlFirewallRuleDataFirewall rule creation/update payload
SqlSkuSKU configuration (tier, capacity)

Common SKUs

Database SKUs

SKU NameTierDescription
BasicBasic5 DTUs, 2 GB max
S0-S12Standard10-3000 DTUs
P1-P15Premium125-4000 DTUs
GP_Gen5_2GeneralPurposevCore-based, 2 vCores
BC_Gen5_2BusinessCriticalvCore-based, 2 vCores
HS_Gen5_2HyperscalevCore-based, 2 vCores

Elastic Pool SKUs

SKU NameTierDescription
BasicPoolBasic50-1600 eDTUs
StandardPoolStandard50-3000 eDTUs
PremiumPoolPremium125-4000 eDTUs
GP_Gen5_2GeneralPurposevCore-based
BC_Gen5_2BusinessCriticalvCore-based

Best Practices

  1. Use WaitUntil.Completed for operations that must finish before proceeding
  2. Use WaitUntil.Started when you want to poll manually or run operations in parallel
  3. Always use DefaultAzureCredential — never hardcode passwords in production
  4. Handle RequestFailedException for ARM API errors
  5. Use CreateOrUpdateAsync for idempotent operations
  6. Navigate hierarchy via Get* methods (e.g., server.GetSqlDatabases())
  7. Use elastic pools for cost optimization when managing multiple databases
  8. Configure firewall rules before attempting connections

Error Handling

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

Reference Files

FileWhen to Read
references/server-management.md [blocked]Server CRUD, admin credentials, Azure AD auth, networking
references/database-operations.md [blocked]Database CRUD, scaling, backup, restore, copy
references/elastic-pools.md [blocked]Pool management, adding/removing databases, scaling

Related SDKs

SDKPurposeInstall
Microsoft.Data.SqlClientData plane (execute queries, stored procedures)dotnet add package Microsoft.Data.SqlClient
Azure.ResourceManager.SqlManagement plane (this SDK)dotnet add package Azure.ResourceManager.Sql
Microsoft.EntityFrameworkCore.SqlServerORM for SQL Serverdotnet add package Microsoft.EntityFrameworkCore.SqlServer

来源与署名

来源:microsoft/skills位于.github/plugins/azure-sdk-dotnet/skills/azure-resource-manager-sql-dotnet提交354361d

许可证: MIT

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架