Azure Resource Manager Mysql Dotnet

1---
2name: azure-resource-manager-mysql-dotnet
3description: |
4  Azure MySQL Flexible Server SDK for .NET. Database management for MySQL Flexible Server deployments. Use for creating servers, databases, firewall rules, configurations, backups, and high availability. Triggers: "MySQL", "MySqlFlexibleServer", "MySQL Flexible Server", "Azure Database for MySQL", "MySQL database management", "MySQL firewall", "MySQL backup".
5package: Azure.ResourceManager.MySql
6---
7 
8# Azure.ResourceManager.MySql (.NET)
9 
10Azure Resource Manager SDK for managing MySQL Flexible Server deployments.
11 
12## Installation
13 
14```bash
15dotnet add package Azure.ResourceManager.MySql
16dotnet add package Azure.Identity
17```
18 
19**Current Version**: v1.2.0 (GA)  
20**API Version**: 2023-12-30
21 
22> **Note**: This skill focuses on MySQL Flexible Server. Single Server is deprecated and scheduled for retirement.
23 
24## Environment Variables
25 
26```bash
27AZURE_SUBSCRIPTION_ID=<your-subscription-id>
28AZURE_RESOURCE_GROUP=<your-resource-group>
29AZURE_MYSQL_SERVER_NAME=<your-mysql-server>
30```
31 
32## Authentication
33 
34```csharp
35using Azure.Identity;
36using Azure.ResourceManager;
37using Azure.ResourceManager.MySql;
38using Azure.ResourceManager.MySql.FlexibleServers;
39 
40ArmClient client = new ArmClient(new DefaultAzureCredential());
41```
42 
43## Resource Hierarchy
44 
45```
46Subscription
47└── ResourceGroup
48    └── MySqlFlexibleServer                 # MySQL Flexible Server instance
49        ├── MySqlFlexibleServerDatabase     # Database within the server
50        ├── MySqlFlexibleServerFirewallRule # IP firewall rules
51        ├── MySqlFlexibleServerConfiguration # Server parameters
52        ├── MySqlFlexibleServerBackup       # Backup information
53        ├── MySqlFlexibleServerMaintenanceWindow # Maintenance schedule
54        └── MySqlFlexibleServerAadAdministrator # Entra ID admin
55```
56 
57## Core Workflows
58 
59### 1. Create MySQL Flexible Server
60 
61```csharp
62using Azure.ResourceManager.MySql.FlexibleServers;
63using Azure.ResourceManager.MySql.FlexibleServers.Models;
64 
65ResourceGroupResource resourceGroup = await client
66    .GetDefaultSubscriptionAsync()
67    .Result
68    .GetResourceGroupAsync("my-resource-group");
69 
70MySqlFlexibleServerCollection servers = resourceGroup.GetMySqlFlexibleServers();
71 
72MySqlFlexibleServerData data = new MySqlFlexibleServerData(AzureLocation.EastUS)
73{
74    Sku = new MySqlFlexibleServerSku("Standard_D2ds_v4", MySqlFlexibleServerSkuTier.GeneralPurpose),
75    AdministratorLogin = "mysqladmin",
76    AdministratorLoginPassword = "YourSecurePassword123!",
77    Version = MySqlFlexibleServerVersion.Ver8_0_21,
78    Storage = new MySqlFlexibleServerStorage
79    {
80        StorageSizeInGB = 128,
81        AutoGrow = MySqlFlexibleServerEnableStatusEnum.Enabled,
82        Iops = 3000
83    },
84    Backup = new MySqlFlexibleServerBackupProperties
85    {
86        BackupRetentionDays = 7,
87        GeoRedundantBackup = MySqlFlexibleServerEnableStatusEnum.Disabled
88    },
89    HighAvailability = new MySqlFlexibleServerHighAvailability
90    {
91        Mode = MySqlFlexibleServerHighAvailabilityMode.ZoneRedundant,
92        StandbyAvailabilityZone = "2"
93    },
94    AvailabilityZone = "1"
95};
96 
97ArmOperation<MySqlFlexibleServerResource> operation = await servers
98    .CreateOrUpdateAsync(WaitUntil.Completed, "my-mysql-server", data);
99 
100MySqlFlexibleServerResource server = operation.Value;
101Console.WriteLine($"Server created: {server.Data.FullyQualifiedDomainName}");
102```
103 
104### 2. Create Database
105 
106```csharp
107MySqlFlexibleServerResource server = await resourceGroup
108    .GetMySqlFlexibleServerAsync("my-mysql-server");
109 
110MySqlFlexibleServerDatabaseCollection databases = server.GetMySqlFlexibleServerDatabases();
111 
112MySqlFlexibleServerDatabaseData dbData = new MySqlFlexibleServerDatabaseData
113{
114    Charset = "utf8mb4",
115    Collation = "utf8mb4_unicode_ci"
116};
117 
118ArmOperation<MySqlFlexibleServerDatabaseResource> operation = await databases
119    .CreateOrUpdateAsync(WaitUntil.Completed, "myappdb", dbData);
120 
121MySqlFlexibleServerDatabaseResource database = operation.Value;
122Console.WriteLine($"Database created: {database.Data.Name}");
123```
124 
125### 3. Configure Firewall Rules
126 
127```csharp
128MySqlFlexibleServerFirewallRuleCollection firewallRules = server.GetMySqlFlexibleServerFirewallRules();
129 
130// Allow specific IP range
131MySqlFlexibleServerFirewallRuleData ruleData = new MySqlFlexibleServerFirewallRuleData
132{
133    StartIPAddress = System.Net.IPAddress.Parse("10.0.0.1"),
134    EndIPAddress = System.Net.IPAddress.Parse("10.0.0.255")
135};
136 
137ArmOperation<MySqlFlexibleServerFirewallRuleResource> operation = await firewallRules
138    .CreateOrUpdateAsync(WaitUntil.Completed, "allow-internal", ruleData);
139 
140// Allow Azure services
141MySqlFlexibleServerFirewallRuleData azureServicesRule = new MySqlFlexibleServerFirewallRuleData
142{
143    StartIPAddress = System.Net.IPAddress.Parse("0.0.0.0"),
144    EndIPAddress = System.Net.IPAddress.Parse("0.0.0.0")
145};
146 
147await firewallRules.CreateOrUpdateAsync(WaitUntil.Completed, "AllowAllAzureServicesAndResourcesWithinAzureIps", azureServicesRule);
148```
149 
150### 4. Update Server Configuration
151 
152```csharp
153MySqlFlexibleServerConfigurationCollection configurations = server.GetMySqlFlexibleServerConfigurations();
154 
155// Get current configuration
156MySqlFlexibleServerConfigurationResource config = await configurations
157    .GetAsync("max_connections");
158 
159// Update configuration
160MySqlFlexibleServerConfigurationData configData = new MySqlFlexibleServerConfigurationData
161{
162    Value = "500",
163    Source = MySqlFlexibleServerConfigurationSource.UserOverride
164};
165 
166ArmOperation<MySqlFlexibleServerConfigurationResource> operation = await configurations
167    .CreateOrUpdateAsync(WaitUntil.Completed, "max_connections", configData);
168 
169// Common configurations to tune
170string[] commonParams = { "max_connections", "innodb_buffer_pool_size", "slow_query_log", "long_query_time" };
171```
172 
173### 5. Configure Entra ID Administrator
174 
175```csharp
176MySqlFlexibleServerAadAdministratorCollection admins = server.GetMySqlFlexibleServerAadAdministrators();
177 
178MySqlFlexibleServerAadAdministratorData adminData = new MySqlFlexibleServerAadAdministratorData
179{
180    AdministratorType = MySqlFlexibleServerAdministratorType.ActiveDirectory,
181    Login = "aad-admin@contoso.com",
182    Sid = Guid.Parse("<entra-object-id>"),
183    TenantId = Guid.Parse("<tenant-id>"),
184    IdentityResourceId = new ResourceIdentifier("/subscriptions/.../userAssignedIdentities/mysql-identity")
185};
186 
187ArmOperation<MySqlFlexibleServerAadAdministratorResource> operation = await admins
188    .CreateOrUpdateAsync(WaitUntil.Completed, "ActiveDirectory", adminData);
189```
190 
191### 6. List and Manage Servers
192 
193```csharp
194// List servers in resource group
195await foreach (MySqlFlexibleServerResource server in resourceGroup.GetMySqlFlexibleServers())
196{
197    Console.WriteLine($"Server: {server.Data.Name}");
198    Console.WriteLine($"  FQDN: {server.Data.FullyQualifiedDomainName}");
199    Console.WriteLine($"  Version: {server.Data.Version}");
200    Console.WriteLine($"  State: {server.Data.State}");
201    Console.WriteLine($"  SKU: {server.Data.Sku.Name} ({server.Data.Sku.Tier})");
202}
203 
204// List databases in server
205await foreach (MySqlFlexibleServerDatabaseResource db in server.GetMySqlFlexibleServerDatabases())
206{
207    Console.WriteLine($"Database: {db.Data.Name}");
208}
209```
210 
211### 7. Backup and Restore
212 
213```csharp
214// List available backups
215await foreach (MySqlFlexibleServerBackupResource backup in server.GetMySqlFlexibleServerBackups())
216{
217    Console.WriteLine($"Backup: {backup.Data.Name}");
218    Console.WriteLine($"  Type: {backup.Data.BackupType}");
219    Console.WriteLine($"  Completed: {backup.Data.CompletedOn}");
220}
221 
222// Point-in-time restore
223MySqlFlexibleServerData restoreData = new MySqlFlexibleServerData(AzureLocation.EastUS)
224{
225    CreateMode = MySqlFlexibleServerCreateMode.PointInTimeRestore,
226    SourceServerResourceId = server.Id,
227    RestorePointInTime = DateTimeOffset.UtcNow.AddHours(-2)
228};
229 
230ArmOperation<MySqlFlexibleServerResource> operation = await servers
231    .CreateOrUpdateAsync(WaitUntil.Completed, "my-mysql-restored", restoreData);
232```
233 
234### 8. Stop and Start Server
235 
236```csharp
237MySqlFlexibleServerResource server = await resourceGroup
238    .GetMySqlFlexibleServerAsync("my-mysql-server");
239 
240// Stop server (saves costs when not in use)
241await server.StopAsync(WaitUntil.Completed);
242 
243// Start server
244await server.StartAsync(WaitUntil.Completed);
245 
246// Restart server
247await server.RestartAsync(WaitUntil.Completed, new MySqlFlexibleServerRestartParameter
248{
249    RestartWithFailover = MySqlFlexibleServerEnableStatusEnum.Enabled,
250    MaxFailoverSeconds = 60
251});
252```
253 
254### 9. Update Server (Scale)
255 
256```csharp
257MySqlFlexibleServerResource server = await resourceGroup
258    .GetMySqlFlexibleServerAsync("my-mysql-server");
259 
260MySqlFlexibleServerPatch patch = new MySqlFlexibleServerPatch
261{
262    Sku = new MySqlFlexibleServerSku("Standard_D4ds_v4", MySqlFlexibleServerSkuTier.GeneralPurpose),
263    Storage = new MySqlFlexibleServerStorage
264    {
265        StorageSizeInGB = 256,
266        Iops = 6000
267    }
268};
269 
270ArmOperation<MySqlFlexibleServerResource> operation = await server
271    .UpdateAsync(WaitUntil.Completed, patch);
272```
273 
274### 10. Delete Server
275 
276```csharp
277MySqlFlexibleServerResource server = await resourceGroup
278    .GetMySqlFlexibleServerAsync("my-mysql-server");
279 
280await server.DeleteAsync(WaitUntil.Completed);
281```
282 
283## Key Types Reference
284 
285| Type | Purpose |
286|------|---------|
287| `MySqlFlexibleServerResource` | Flexible Server instance |
288| `MySqlFlexibleServerData` | Server configuration data |
289| `MySqlFlexibleServerCollection` | Collection of servers |
290| `MySqlFlexibleServerDatabaseResource` | Database within server |
291| `MySqlFlexibleServerFirewallRuleResource` | IP firewall rule |
292| `MySqlFlexibleServerConfigurationResource` | Server parameter |
293| `MySqlFlexibleServerBackupResource` | Backup metadata |
294| `MySqlFlexibleServerAadAdministratorResource` | Entra ID admin |
295| `MySqlFlexibleServerSku` | SKU (compute tier + size) |
296| `MySqlFlexibleServerStorage` | Storage configuration |
297| `MySqlFlexibleServerHighAvailability` | HA configuration |
298| `MySqlFlexibleServerBackupProperties` | Backup settings |
299 
300## SKU Tiers
301 
302| Tier | Use Case | SKU Examples |
303|------|----------|--------------|
304| `Burstable` | Dev/test, light workloads | Standard_B1ms, Standard_B2s |
305| `GeneralPurpose` | Production workloads | Standard_D2ds_v4, Standard_D4ds_v4 |
306| `MemoryOptimized` | High memory requirements | Standard_E2ds_v4, Standard_E4ds_v4 |
307 
308## High Availability Modes
309 
310| Mode | Description |
311|------|-------------|
312| `Disabled` | No HA (single server) |
313| `SameZone` | HA within same availability zone |
314| `ZoneRedundant` | HA across availability zones |
315 
316## Best Practices
317 
3181. **Use Flexible Server** — Single Server is deprecated
3192. **Enable zone-redundant HA** — For production workloads
3203. **Use DefaultAzureCredential** — Prefer over connection strings
3214. **Configure Entra ID authentication** — More secure than SQL auth
3225. **Enable auto-grow storage** — Prevents out-of-space issues
3236. **Set appropriate backup retention** — 7-35 days based on compliance
3247. **Use private endpoints** — For secure network access
3258. **Tune server parameters** — Based on workload characteristics
3269. **Monitor with Azure Monitor** — Enable metrics and logs
32710. **Stop dev/test servers** — Save costs when not in use
328 
329## Error Handling
330 
331```csharp
332using Azure;
333 
334try
335{
336    ArmOperation<MySqlFlexibleServerResource> operation = await servers
337        .CreateOrUpdateAsync(WaitUntil.Completed, "my-mysql", data);
338}
339catch (RequestFailedException ex) when (ex.Status == 409)
340{
341    Console.WriteLine("Server already exists");
342}
343catch (RequestFailedException ex) when (ex.Status == 400)
344{
345    Console.WriteLine($"Invalid configuration: {ex.Message}");
346}
347catch (RequestFailedException ex)
348{
349    Console.WriteLine($"Azure error: {ex.Status} - {ex.Message}");
350}
351```
352 
353## Connection String
354 
355After creating the server, connect using:
356 
357```csharp
358// ADO.NET connection string
359string connectionString = $"Server={server.Data.FullyQualifiedDomainName};" +
360    "Database=myappdb;" +
361    "User Id=mysqladmin;" +
362    "Password=YourSecurePassword123!;" +
363    "SslMode=Required;";
364 
365// With Entra ID token (recommended)
366var credential = new DefaultAzureCredential();
367var token = await credential.GetTokenAsync(
368    new TokenRequestContext(new[] { "https://ossrdbms-aad.database.windows.net/.default" }));
369 
370string connectionString = $"Server={server.Data.FullyQualifiedDomainName};" +
371    "Database=myappdb;" +
372    $"User Id=aad-admin@contoso.com;" +
373    $"Password={token.Token};" +
374    "SslMode=Required;";
375```
376 
377## Related SDKs
378 
379| SDK | Purpose | Install |
380|-----|---------|---------|
381| `Azure.ResourceManager.MySql` | MySQL management (this SDK) | `dotnet add package Azure.ResourceManager.MySql` |
382| `Azure.ResourceManager.PostgreSql` | PostgreSQL management | `dotnet add package Azure.ResourceManager.PostgreSql` |
383| `MySqlConnector` | MySQL data access | `dotnet add package MySqlConnector` |
384 
385## Reference Links
386 
387| Resource | URL |
388|----------|-----|
389| NuGet Package | https://www.nuget.org/packages/Azure.ResourceManager.MySql |
390| API Reference | https://learn.microsoft.com/dotnet/api/azure.resourcemanager.mysql |
391| Product Documentation | https://learn.microsoft.com/azure/mysql/flexible-server/ |
392| GitHub Source | https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/mysql/Azure.ResourceManager.MySql |
393