azure-resource-manager-mysql-dotnet

Azure.ResourceManager.MySql（.NET）

MySQL Flexible Server デプロイを管理するための Azure Resource Manager SDK です。

インストール

dotnet add package Azure.ResourceManager.MySql
dotnet add package Azure.Identity

過去の例の基準バージョン：v1.2.0。現在互換性のあるパッケージ／型を確認してください API バージョン：2023-12-30

注：このスキルは MySQL Flexible Server に重点を置いています。Single Server は廃止されているため、現在の Flexible Server 移行ガイダンスを使用してください。

環境変数

AZURE_SUBSCRIPTION_ID=<your-subscription-id>
AZURE_RESOURCE_GROUP=<your-resource-group>
AZURE_MYSQL_SERVER_NAME=<your-mysql-server>

認証

using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.MySql;
using Azure.ResourceManager.MySql.FlexibleServers;

ArmClient client = new ArmClient(new DefaultAzureCredential());

リソース階層

Subscription
└── ResourceGroup
    └── MySqlFlexibleServer                 # MySQL Flexible Server instance
        ├── MySqlFlexibleServerDatabase     # Database within the server
        ├── MySqlFlexibleServerFirewallRule # IP firewall rules
        ├── MySqlFlexibleServerConfiguration # Server parameters
        ├── MySqlFlexibleServerBackup       # Backup information
        ├── MySqlFlexibleServerMaintenanceWindow # Maintenance schedule
        └── MySqlFlexibleServerAadAdministrator # Entra ID admin

主なワークフロー

1. MySQL Flexible Server を作成する

using System;
using Azure.ResourceManager.MySql.FlexibleServers;
using Azure.ResourceManager.MySql.FlexibleServers.Models;

using Azure.ResourceManager.Resources;
using Azure.Core;
using Azure;

var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID")
    ?? throw new InvalidOperationException("AZURE_SUBSCRIPTION_ID is required");
var subscription = client.GetSubscriptionResource(new ResourceIdentifier($"/subscriptions/{subscriptionId}"));
ResourceGroupResource resourceGroup = (await subscription.GetResourceGroupAsync("my-resource-group")).Value;

MySqlFlexibleServerCollection servers = resourceGroup.GetMySqlFlexibleServers();

MySqlFlexibleServerData data = new MySqlFlexibleServerData(AzureLocation.EastUS)
{
    Sku = new MySqlFlexibleServerSku("Standard_D2ds_v4", MySqlFlexibleServerSkuTier.GeneralPurpose),
    AdministratorLogin = "mysqladmin",
    AdministratorLoginPassword = Environment.GetEnvironmentVariable("MYSQL_ADMIN_PASSWORD") ?? throw new InvalidOperationException("MYSQL_ADMIN_PASSWORD is required"),
    Version = MySqlFlexibleServerVersion.Ver8_0_21,
    Storage = new MySqlFlexibleServerStorage
    {
        StorageSizeInGB = 128,
        AutoGrow = MySqlFlexibleServerEnableStatusEnum.Enabled,
        Iops = 3000
    },
    Backup = new MySqlFlexibleServerBackupProperties
    {
        BackupRetentionDays = 7,
        GeoRedundantBackup = MySqlFlexibleServerEnableStatusEnum.Disabled
    },
    HighAvailability = new MySqlFlexibleServerHighAvailability
    {
        Mode = MySqlFlexibleServerHighAvailabilityMode.ZoneRedundant,
        StandbyAvailabilityZone = "2"
    },
    AvailabilityZone = "1"
};

ArmOperation<MySqlFlexibleServerResource> operation = await servers
    .CreateOrUpdateAsync(WaitUntil.Completed, "my-mysql-server", data);

MySqlFlexibleServerResource server = operation.Value;
Console.WriteLine($"Server created: {server.Data.FullyQualifiedDomainName}");

2. データベースを作成する

MySqlFlexibleServerResource server = await resourceGroup
    .GetMySqlFlexibleServerAsync("my-mysql-server");

MySqlFlexibleServerDatabaseCollection databases = server.GetMySqlFlexibleServerDatabases();

MySqlFlexibleServerDatabaseData dbData = new MySqlFlexibleServerDatabaseData
{
    Charset = "utf8mb4",
    Collation = "utf8mb4_unicode_ci"
};

ArmOperation<MySqlFlexibleServerDatabaseResource> operation = await databases
    .CreateOrUpdateAsync(WaitUntil.Completed, "myappdb", dbData);

MySqlFlexibleServerDatabaseResource database = operation.Value;
Console.WriteLine($"Database created: {database.Data.Name}");

3. ファイアウォール規則を構成する

MySqlFlexibleServerFirewallRuleCollection firewallRules = server.GetMySqlFlexibleServerFirewallRules();

// Allow specific IP range
MySqlFlexibleServerFirewallRuleData ruleData = new MySqlFlexibleServerFirewallRuleData
{
    StartIPAddress = System.Net.IPAddress.Parse("10.0.0.1"),
    EndIPAddress = System.Net.IPAddress.Parse("10.0.0.255")
};

ArmOperation<MySqlFlexibleServerFirewallRuleResource> operation = await firewallRules
    .CreateOrUpdateAsync(WaitUntil.Completed, "allow-internal", ruleData);

// Allow Azure services
MySqlFlexibleServerFirewallRuleData azureServicesRule = new MySqlFlexibleServerFirewallRuleData
{
    StartIPAddress = System.Net.IPAddress.Parse("0.0.0.0"),
    EndIPAddress = System.Net.IPAddress.Parse("0.0.0.0")
};

await firewallRules.CreateOrUpdateAsync(WaitUntil.Completed, "AllowAllAzureServicesAndResourcesWithinAzureIps", azureServicesRule);

4. サーバー構成を更新する

MySqlFlexibleServerConfigurationCollection configurations = server.GetMySqlFlexibleServerConfigurations();

// Get current configuration
MySqlFlexibleServerConfigurationResource config = await configurations
    .GetAsync("max_connections");

// Update configuration
MySqlFlexibleServerConfigurationData configData = new MySqlFlexibleServerConfigurationData
{
    Value = "500",
    Source = MySqlFlexibleServerConfigurationSource.UserOverride
};

ArmOperation<MySqlFlexibleServerConfigurationResource> operation = await configurations
    .CreateOrUpdateAsync(WaitUntil.Completed, "max_connections", configData);

// Common configurations to tune
string[] commonParams = { "max_connections", "innodb_buffer_pool_size", "slow_query_log", "long_query_time" };

5. Entra ID 管理者を構成する

MySqlFlexibleServerAadAdministratorCollection admins = server.GetMySqlFlexibleServerAadAdministrators();

MySqlFlexibleServerAadAdministratorData adminData = new MySqlFlexibleServerAadAdministratorData
{
    AdministratorType = MySqlFlexibleServerAdministratorType.ActiveDirectory,
    Login = "[email protected]",
    Sid = Guid.Parse("<entra-object-id>"),
    TenantId = Guid.Parse("<tenant-id>"),
    IdentityResourceId = new ResourceIdentifier("/subscriptions/.../userAssignedIdentities/mysql-identity")
};

ArmOperation<MySqlFlexibleServerAadAdministratorResource> operation = await admins
    .CreateOrUpdateAsync(WaitUntil.Completed, "ActiveDirectory", adminData);

6. サーバーを一覧表示して管理する

// List servers in resource group
await foreach (MySqlFlexibleServerResource server in resourceGroup.GetMySqlFlexibleServers().GetAllAsync())
{
    Console.WriteLine($"Server: {server.Data.Name}");
    Console.WriteLine($"  FQDN: {server.Data.FullyQualifiedDomainName}");
    Console.WriteLine($"  Version: {server.Data.Version}");
    Console.WriteLine($"  State: {server.Data.State}");
    Console.WriteLine($"  SKU: {server.Data.Sku.Name} ({server.Data.Sku.Tier})");
}

// List databases in server
await foreach (MySqlFlexibleServerDatabaseResource db in server.GetMySqlFlexibleServerDatabases().GetAllAsync())
{
    Console.WriteLine($"Database: {db.Data.Name}");
}

7. バックアップと復元

// List available backups
await foreach (MySqlFlexibleServerBackupResource backup in server.GetMySqlFlexibleServerBackups().GetAllAsync())
{
    Console.WriteLine($"Backup: {backup.Data.Name}");
    Console.WriteLine($"  Type: {backup.Data.BackupType}");
    Console.WriteLine($"  Completed: {backup.Data.CompletedOn}");
}

// Point-in-time restore
MySqlFlexibleServerData restoreData = new MySqlFlexibleServerData(AzureLocation.EastUS)
{
    CreateMode = MySqlFlexibleServerCreateMode.PointInTimeRestore,
    SourceServerResourceId = server.Id,
    RestorePointInTime = DateTimeOffset.UtcNow.AddHours(-2)
};

ArmOperation<MySqlFlexibleServerResource> operation = await servers
    .CreateOrUpdateAsync(WaitUntil.Completed, "my-mysql-restored", restoreData);

8. サーバーを停止および起動する

MySqlFlexibleServerResource server = await resourceGroup
    .GetMySqlFlexibleServerAsync("my-mysql-server");

// Stop server (saves costs when not in use)
await server.StopAsync(WaitUntil.Completed);

// Start server
await server.StartAsync(WaitUntil.Completed);

// Restart server
await server.RestartAsync(WaitUntil.Completed, new MySqlFlexibleServerRestartParameter
{
    RestartWithFailover = MySqlFlexibleServerEnableStatusEnum.Enabled,
    MaxFailoverSeconds = 60
});

9. サーバーを更新する（スケール）

MySqlFlexibleServerResource server = await resourceGroup
    .GetMySqlFlexibleServerAsync("my-mysql-server");

MySqlFlexibleServerPatch patch = new MySqlFlexibleServerPatch
{
    Sku = new MySqlFlexibleServerSku("Standard_D4ds_v4", MySqlFlexibleServerSkuTier.GeneralPurpose),
    Storage = new MySqlFlexibleServerStorage
    {
        StorageSizeInGB = 256,
        Iops = 6000
    }
};

ArmOperation<MySqlFlexibleServerResource> operation = await server
    .UpdateAsync(WaitUntil.Completed, patch);

10. サーバーを削除する

MySqlFlexibleServerResource server = await resourceGroup
    .GetMySqlFlexibleServerAsync("my-mysql-server");

await server.DeleteAsync(WaitUntil.Completed);

主な型のリファレンス

型	用途
MySqlFlexibleServerResource	Flexible Server インスタンス
MySqlFlexibleServerData	サーバー構成データ
MySqlFlexibleServerCollection	サーバーのコレクション
MySqlFlexibleServerDatabaseResource	サーバー内のデータベース
MySqlFlexibleServerFirewallRuleResource	IP ファイアウォール規則
MySqlFlexibleServerConfigurationResource	サーバーパラメーター
MySqlFlexibleServerBackupResource	バックアップのメタデータ
MySqlFlexibleServerAadAdministratorResource	Entra ID 管理者
MySqlFlexibleServerSku	SKU（コンピューティング階層＋サイズ）
MySqlFlexibleServerStorage	ストレージ構成
MySqlFlexibleServerHighAvailability	HA 構成
MySqlFlexibleServerBackupProperties	バックアップ設定

SKU 階層

階層	用途	SKU の例
Burstable	開発／テスト、軽いワークロード	Standard_B1ms, Standard_B2s
GeneralPurpose	本番ワークロード	Standard_D2ds_v4, Standard_D4ds_v4
MemoryOptimized	大容量メモリが必要な場合	Standard_E2ds_v4, Standard_E4ds_v4

高可用性モード

モード	説明
Disabled	HA なし（単一サーバー）
SameZone	同じ可用性ゾーン内での HA
ZoneRedundant	可用性ゾーン間での HA

ベストプラクティス

1. Flexible Server を使用する — Single Server は非推奨です
2. ゾーン冗長 HA を有効にする — 本番ワークロード向け
3. DefaultAzureCredential を使用する — 接続文字列よりも優先してください
4. Entra ID 認証を構成する — SQL 認証より安全です
5. ストレージの自動拡張を有効にする — 空き容量不足を防ぎます
6. 適切なバックアップ保持期間を設定する — コンプライアンス要件に応じて 7～35 日
7. プライベートエンドポイントを使用する — 安全なネットワークアクセスのため
8. サーバーパラメーターを調整する — ワークロードの特性に応じて設定してください
9. Azure Monitor で監視する — メトリックとログを有効にしてください
10. 開発／テスト用サーバーを停止する — 使用していないときのコストを削減します

エラー処理

using Azure;

try
{
    ArmOperation<MySqlFlexibleServerResource> operation = await servers
        .CreateOrUpdateAsync(WaitUntil.Completed, "my-mysql", data);
}
catch (RequestFailedException ex) when (ex.Status == 409)
{
    Console.WriteLine("Conflict; inspect provider code and current operation state");
}
catch (RequestFailedException ex) when (ex.Status == 400)
{
    Console.WriteLine($"Invalid configuration: {ex.Message}");
}
catch (RequestFailedException ex)
{
    Console.WriteLine($"Azure error: {ex.Status} - {ex.Message}");
}

接続文字列

サーバーの作成後、次の方法で接続します。

// ADO.NET connection string
string connectionString = $"Server={server.Data.FullyQualifiedDomainName};" +
    "Database=myappdb;" +
    "User Id=mysqladmin;" +
     $"Password={Environment.GetEnvironmentVariable("MYSQL_ADMIN_PASSWORD")};" +
    "SslMode=VerifyFull;";

// With Entra ID token (recommended)
var credential = new DefaultAzureCredential();
var token = await credential.GetTokenAsync(
    new TokenRequestContext(new[] { "https://ossrdbms-aad.database.windows.net/.default" }));

string connectionString = $"Server={server.Data.FullyQualifiedDomainName};" +
    "Database=myappdb;" +
    $"User [email protected];" +
    $"Password={token.Token};" +
    "SslMode=VerifyFull;";

関連 SDK

SDK	用途	インストール
Azure.ResourceManager.MySql	MySQL の管理（この SDK）	dotnet add package Azure.ResourceManager.MySql
Azure.ResourceManager.PostgreSql	PostgreSQL の管理	dotnet add package Azure.ResourceManager.PostgreSql
MySqlConnector	MySQL データアクセス	dotnet add package MySqlConnector

参考リンク

リソース	URL
NuGet パッケージ	https://www.nuget.org/packages/Azure.ResourceManager.MySql
API リファレンス	https://learn.microsoft.com/dotnet/api/azure.resourcemanager.mysql
製品ドキュメント	https://learn.microsoft.com/azure/mysql/flexible-server/
GitHub ソース	https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/mysql/Azure.ResourceManager.MySql

使用する場面

このスキルは、概要で説明されているワークフローまたはアクションを実行する際に使用できます。

制限事項

• このスキルは、タスクが上記の説明された範囲に明確に該当する場合にのみ使用してください。
• 出力を、環境固有の検証、テスト、または専門家によるレビューの代わりとして扱わないでください。
• 必要な入力、権限、安全上の境界、または成功基準が不足している場合は、作業を中止して確認を求めてください。

これらは独立した過去のスニペットであり、コンパイル済みのデプロイテンプレートではありません。生成された型／SKU／ゾーン／API バージョンを検証し、省略されたインポートを追加してください。また、パスワード／トークンを正しくエスケープするため、コネクターの接続文字列ビルダーを使用してください。期限切れのトークンを再利用するのではなく、新しいプール接続で Entra トークンを更新してください。管理用の認証情報だけでは、データベースへのログインは自動的に許可されません。パブリックファイアウォールルールには実際のパブリックエグレスアドレスを使用してください。10.x の範囲ではプライベートネットワークは確立されません。0.0.0.0 の Azure サービスルールは、すべての Azure テナントに広く適用されるため、明示的なスコープ指定が必要です。停止後もストレージ料金が発生する場合があり、サービスの制限に応じて自動再起動することもあります。復元すると新しいエンドポイントが作成され、スケール変更／再起動によってサービスが中断される可能性があります。また、自動拡張は容量を保証するものではありません。削除する場合は、対象とバックアップの復旧範囲を明示的に指定する必要があります。