Azure Resource Manager SQL Dotnet

1---
2name: azure-resource-manager-sql-dotnet
3description: |
4  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".
5package: Azure.ResourceManager.Sql
6---
7 
8# Azure.ResourceManager.Sql (.NET)
9 
10Management plane SDK for provisioning and managing Azure SQL resources via Azure Resource Manager.
11 
12> **⚠️ Management vs Data Plane**
13> - **This SDK (Azure.ResourceManager.Sql)**: Create servers, databases, elastic pools, configure firewall rules, manage failover groups
14> - **Data Plane SDK (Microsoft.Data.SqlClient)**: Execute queries, stored procedures, manage connections
15 
16## Installation
17 
18```bash
19dotnet add package Azure.ResourceManager.Sql
20dotnet add package Azure.Identity
21```
22 
23**Current Versions**: Stable v1.3.0, Preview v1.4.0-beta.3
24 
25## Environment Variables
26 
27```bash
28AZURE_SUBSCRIPTION_ID=<your-subscription-id>
29# For service principal auth (optional)
30AZURE_TENANT_ID=<tenant-id>
31AZURE_CLIENT_ID=<client-id>
32AZURE_CLIENT_SECRET=<client-secret>
33```
34 
35## Authentication
36 
37```csharp
38using Azure.Identity;
39using Azure.ResourceManager;
40using Azure.ResourceManager.Sql;
41 
42// Always use DefaultAzureCredential
43var credential = new DefaultAzureCredential();
44var armClient = new ArmClient(credential);
45 
46// Get subscription
47var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID");
48var subscription = armClient.GetSubscriptionResource(
49    new ResourceIdentifier($"/subscriptions/{subscriptionId}"));
50```
51 
52## Resource Hierarchy
53 
54```
55ArmClient
56└── SubscriptionResource
57    └── ResourceGroupResource
58        └── SqlServerResource
59            ├── SqlDatabaseResource
60            ├── ElasticPoolResource
61            │   └── ElasticPoolDatabaseResource
62            ├── SqlFirewallRuleResource
63            ├── FailoverGroupResource
64            ├── ServerBlobAuditingPolicyResource
65            ├── EncryptionProtectorResource
66            └── VirtualNetworkRuleResource
67```
68 
69## Core Workflow
70 
71### 1. Create SQL Server
72 
73```csharp
74using Azure.ResourceManager.Sql;
75using Azure.ResourceManager.Sql.Models;
76 
77// Get resource group
78var resourceGroup = await subscription
79    .GetResourceGroupAsync("my-resource-group");
80 
81// Define server
82var serverData = new SqlServerData(AzureLocation.EastUS)
83{
84    AdministratorLogin = "sqladmin",
85    AdministratorLoginPassword = "YourSecurePassword123!",
86    Version = "12.0",
87    MinimalTlsVersion = SqlMinimalTlsVersion.Tls1_2,
88    PublicNetworkAccess = ServerNetworkAccessFlag.Enabled
89};
90 
91// Create server (long-running operation)
92var serverCollection = resourceGroup.Value.GetSqlServers();
93var operation = await serverCollection.CreateOrUpdateAsync(
94    WaitUntil.Completed,
95    "my-sql-server",
96    serverData);
97 
98SqlServerResource server = operation.Value;
99```
100 
101### 2. Create SQL Database
102 
103```csharp
104var databaseData = new SqlDatabaseData(AzureLocation.EastUS)
105{
106    Sku = new SqlSku("S0") { Tier = "Standard" },
107    MaxSizeBytes = 2L * 1024 * 1024 * 1024, // 2 GB
108    Collation = "SQL_Latin1_General_CP1_CI_AS",
109    RequestedBackupStorageRedundancy = SqlBackupStorageRedundancy.Local
110};
111 
112var databaseCollection = server.GetSqlDatabases();
113var dbOperation = await databaseCollection.CreateOrUpdateAsync(
114    WaitUntil.Completed,
115    "my-database",
116    databaseData);
117 
118SqlDatabaseResource database = dbOperation.Value;
119```
120 
121### 3. Create Elastic Pool
122 
123```csharp
124var poolData = new ElasticPoolData(AzureLocation.EastUS)
125{
126    Sku = new SqlSku("StandardPool")
127    {
128        Tier = "Standard",
129        Capacity = 100 // 100 eDTUs
130    },
131    PerDatabaseSettings = new ElasticPoolPerDatabaseSettings
132    {
133        MinCapacity = 0,
134        MaxCapacity = 100
135    }
136};
137 
138var poolCollection = server.GetElasticPools();
139var poolOperation = await poolCollection.CreateOrUpdateAsync(
140    WaitUntil.Completed,
141    "my-elastic-pool",
142    poolData);
143 
144ElasticPoolResource pool = poolOperation.Value;
145```
146 
147### 4. Add Database to Elastic Pool
148 
149```csharp
150var databaseData = new SqlDatabaseData(AzureLocation.EastUS)
151{
152    ElasticPoolId = pool.Id
153};
154 
155await databaseCollection.CreateOrUpdateAsync(
156    WaitUntil.Completed,
157    "pooled-database",
158    databaseData);
159```
160 
161### 5. Configure Firewall Rules
162 
163```csharp
164// Allow Azure services
165var azureServicesRule = new SqlFirewallRuleData
166{
167    StartIPAddress = "0.0.0.0",
168    EndIPAddress = "0.0.0.0"
169};
170 
171var firewallCollection = server.GetSqlFirewallRules();
172await firewallCollection.CreateOrUpdateAsync(
173    WaitUntil.Completed,
174    "AllowAzureServices",
175    azureServicesRule);
176 
177// Allow specific IP range
178var clientRule = new SqlFirewallRuleData
179{
180    StartIPAddress = "203.0.113.0",
181    EndIPAddress = "203.0.113.255"
182};
183 
184await firewallCollection.CreateOrUpdateAsync(
185    WaitUntil.Completed,
186    "AllowClientIPs",
187    clientRule);
188```
189 
190### 6. List Resources
191 
192```csharp
193// List all servers in subscription
194await foreach (var srv in subscription.GetSqlServersAsync())
195{
196    Console.WriteLine($"Server: {srv.Data.Name} in {srv.Data.Location}");
197}
198 
199// List databases in a server
200await foreach (var db in server.GetSqlDatabases())
201{
202    Console.WriteLine($"Database: {db.Data.Name}, SKU: {db.Data.Sku?.Name}");
203}
204 
205// List elastic pools
206await foreach (var ep in server.GetElasticPools())
207{
208    Console.WriteLine($"Pool: {ep.Data.Name}, DTU: {ep.Data.Sku?.Capacity}");
209}
210```
211 
212### 7. Get Connection String
213 
214```csharp
215// Build connection string (server FQDN is predictable)
216var serverFqdn = $"{server.Data.Name}.database.windows.net";
217var connectionString = $"Server=tcp:{serverFqdn},1433;" +
218    $"Initial Catalog={database.Data.Name};" +
219    "Persist Security Info=False;" +
220    $"User ID={server.Data.AdministratorLogin};" +
221    "Password=<your-password>;" +
222    "MultipleActiveResultSets=False;" +
223    "Encrypt=True;" +
224    "TrustServerCertificate=False;" +
225    "Connection Timeout=30;";
226```
227 
228## Key Types Reference
229 
230| Type | Purpose |
231|------|---------|
232| `ArmClient` | Entry point for all ARM operations |
233| `SqlServerResource` | Represents an Azure SQL server |
234| `SqlServerCollection` | Collection for server CRUD |
235| `SqlDatabaseResource` | Represents a SQL database |
236| `SqlDatabaseCollection` | Collection for database CRUD |
237| `ElasticPoolResource` | Represents an elastic pool |
238| `ElasticPoolCollection` | Collection for elastic pool CRUD |
239| `SqlFirewallRuleResource` | Represents a firewall rule |
240| `SqlFirewallRuleCollection` | Collection for firewall rule CRUD |
241| `SqlServerData` | Server creation/update payload |
242| `SqlDatabaseData` | Database creation/update payload |
243| `ElasticPoolData` | Elastic pool creation/update payload |
244| `SqlFirewallRuleData` | Firewall rule creation/update payload |
245| `SqlSku` | SKU configuration (tier, capacity) |
246 
247## Common SKUs
248 
249### Database SKUs
250 
251| SKU Name | Tier | Description |
252|----------|------|-------------|
253| `Basic` | Basic | 5 DTUs, 2 GB max |
254| `S0`-`S12` | Standard | 10-3000 DTUs |
255| `P1`-`P15` | Premium | 125-4000 DTUs |
256| `GP_Gen5_2` | GeneralPurpose | vCore-based, 2 vCores |
257| `BC_Gen5_2` | BusinessCritical | vCore-based, 2 vCores |
258| `HS_Gen5_2` | Hyperscale | vCore-based, 2 vCores |
259 
260### Elastic Pool SKUs
261 
262| SKU Name | Tier | Description |
263|----------|------|-------------|
264| `BasicPool` | Basic | 50-1600 eDTUs |
265| `StandardPool` | Standard | 50-3000 eDTUs |
266| `PremiumPool` | Premium | 125-4000 eDTUs |
267| `GP_Gen5_2` | GeneralPurpose | vCore-based |
268| `BC_Gen5_2` | BusinessCritical | vCore-based |
269 
270## Best Practices
271 
2721. **Use `WaitUntil.Completed`** for operations that must finish before proceeding
2732. **Use `WaitUntil.Started`** when you want to poll manually or run operations in parallel
2743. **Always use `DefaultAzureCredential`** — never hardcode passwords in production
2754. **Handle `RequestFailedException`** for ARM API errors
2765. **Use `CreateOrUpdateAsync`** for idempotent operations
2776. **Navigate hierarchy** via `Get*` methods (e.g., `server.GetSqlDatabases()`)
2787. **Use elastic pools** for cost optimization when managing multiple databases
2798. **Configure firewall rules** before attempting connections
280 
281## Error Handling
282 
283```csharp
284using Azure;
285 
286try
287{
288    var operation = await serverCollection.CreateOrUpdateAsync(
289        WaitUntil.Completed, serverName, serverData);
290}
291catch (RequestFailedException ex) when (ex.Status == 409)
292{
293    Console.WriteLine("Server already exists");
294}
295catch (RequestFailedException ex) when (ex.Status == 400)
296{
297    Console.WriteLine($"Invalid request: {ex.Message}");
298}
299catch (RequestFailedException ex)
300{
301    Console.WriteLine($"ARM Error: {ex.Status} - {ex.ErrorCode}: {ex.Message}");
302}
303```
304 
305## Reference Files
306 
307| File | When to Read |
308|------|--------------|
309| [references/server-management.md](references/server-management.md) | Server CRUD, admin credentials, Azure AD auth, networking |
310| [references/database-operations.md](references/database-operations.md) | Database CRUD, scaling, backup, restore, copy |
311| [references/elastic-pools.md](references/elastic-pools.md) | Pool management, adding/removing databases, scaling |
312 
313## Related SDKs
314 
315| SDK | Purpose | Install |
316|-----|---------|---------|
317| `Microsoft.Data.SqlClient` | Data plane (execute queries, stored procedures) | `dotnet add package Microsoft.Data.SqlClient` |
318| `Azure.ResourceManager.Sql` | Management plane (this SDK) | `dotnet add package Azure.ResourceManager.Sql` |
319| `Microsoft.EntityFrameworkCore.SqlServer` | ORM for SQL Server | `dotnet add package Microsoft.EntityFrameworkCore.SqlServer` |
320