Azure Resource Manager Redis Dotnet

Azure.ResourceManager.Redis (.NET)

管理平面 SDK，用于通过 Azure Resource Manager 预配和管理 Azure Cache for Redis 资源。

⚠️ 管理平面 vs 数据平面

• 本 SDK (Azure.ResourceManager.Redis)：创建缓存、配置防火墙规则、管理访问密钥、设置异地复制
• 数据平面 SDK (StackExchange.Redis)：Get/Set 键、发布/订阅、流、Lua 脚本

安装

dotnet add package Azure.ResourceManager.Redis
dotnet add package Azure.Identity

当前版本：1.5.1（稳定版） API 版本：2024-11-01 目标框架：.NET 8.0、.NET Standard 2.0

环境变量

AZURE_SUBSCRIPTION_ID=<your-subscription-id>
# For service principal auth (optional)
AZURE_TENANT_ID=<tenant-id>
AZURE_CLIENT_ID=<client-id>
AZURE_CLIENT_SECRET=<client-secret>

身份认证

using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Redis;

// Always use DefaultAzureCredential
var credential = new DefaultAzureCredential();
var armClient = new ArmClient(credential);

// Get subscription
var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID");
var subscription = armClient.GetSubscriptionResource(
    new ResourceIdentifier($"/subscriptions/{subscriptionId}"));

资源层级

ArmClient
└── SubscriptionResource
    └── ResourceGroupResource
        └── RedisResource
            ├── RedisFirewallRuleResource
            ├── RedisPatchScheduleResource
            ├── RedisLinkedServerWithPropertyResource
            ├── RedisPrivateEndpointConnectionResource
            └── RedisCacheAccessPolicyResource

核心工作流

1. 创建 Redis 缓存

using Azure.ResourceManager.Redis;
using Azure.ResourceManager.Redis.Models;

// Get resource group
var resourceGroup = await subscription
    .GetResourceGroupAsync("my-resource-group");

// Define cache configuration
var cacheData = new RedisCreateOrUpdateContent(
    location: AzureLocation.EastUS,
    sku: new RedisSku(RedisSkuName.Standard, RedisSkuFamily.BasicOrStandard, 1))
{
    EnableNonSslPort = false,
    MinimumTlsVersion = RedisTlsVersion.Tls1_2,
    RedisConfiguration = new RedisCommonConfiguration
    {
        MaxMemoryPolicy = "volatile-lru"
    },
    Tags =
    {
        ["environment"] = "production"
    }
};

// Create cache (long-running operation)
var cacheCollection = resourceGroup.Value.GetAllRedis();
var operation = await cacheCollection.CreateOrUpdateAsync(
    WaitUntil.Completed,
    "my-redis-cache",
    cacheData);

RedisResource cache = operation.Value;
Console.WriteLine($"Cache created: {cache.Data.HostName}");

2. 获取 Redis 缓存

// Get existing cache
var cache = await resourceGroup.Value
    .GetRedisAsync("my-redis-cache");

Console.WriteLine($"Host: {cache.Value.Data.HostName}");
Console.WriteLine($"Port: {cache.Value.Data.Port}");
Console.WriteLine($"SSL Port: {cache.Value.Data.SslPort}");
Console.WriteLine($"Provisioning State: {cache.Value.Data.ProvisioningState}");

3. 更新 Redis 缓存

var patchData = new RedisPatch
{
    Sku = new RedisSku(RedisSkuName.Standard, RedisSkuFamily.BasicOrStandard, 2),
    RedisConfiguration = new RedisCommonConfiguration
    {
        MaxMemoryPolicy = "allkeys-lru"
    }
};

var updateOperation = await cache.Value.UpdateAsync(
    WaitUntil.Completed,
    patchData);

4. 删除 Redis 缓存

await cache.Value.DeleteAsync(WaitUntil.Completed);

5. 获取访问密钥

var keys = await cache.Value.GetKeysAsync();
Console.WriteLine($"Primary Key: {keys.Value.PrimaryKey}");
Console.WriteLine($"Secondary Key: {keys.Value.SecondaryKey}");

6. 重新生成访问密钥

var regenerateContent = new RedisRegenerateKeyContent(RedisRegenerateKeyType.Primary);
var newKeys = await cache.Value.RegenerateKeyAsync(regenerateContent);
Console.WriteLine($"New Primary Key: {newKeys.Value.PrimaryKey}");

7. 管理防火墙规则

// Create firewall rule
var firewallData = new RedisFirewallRuleData(
    startIP: System.Net.IPAddress.Parse("10.0.0.1"),
    endIP: System.Net.IPAddress.Parse("10.0.0.255"));

var firewallCollection = cache.Value.GetRedisFirewallRules();
var firewallOperation = await firewallCollection.CreateOrUpdateAsync(
    WaitUntil.Completed,
    "allow-internal-network",
    firewallData);

// List all firewall rules
await foreach (var rule in firewallCollection.GetAllAsync())
{
    Console.WriteLine($"Rule: {rule.Data.Name} ({rule.Data.StartIP} - {rule.Data.EndIP})");
}

// Delete firewall rule
var ruleToDelete = await firewallCollection.GetAsync("allow-internal-network");
await ruleToDelete.Value.DeleteAsync(WaitUntil.Completed);

8. 配置补丁计划（Premium SKU）

// Patch schedules require Premium SKU
var scheduleData = new RedisPatchScheduleData(
    new[]
    {
        new RedisPatchScheduleSetting(RedisDayOfWeek.Saturday, 2) // 2 AM Saturday
        {
            MaintenanceWindow = TimeSpan.FromHours(5)
        },
        new RedisPatchScheduleSetting(RedisDayOfWeek.Sunday, 2) // 2 AM Sunday
        {
            MaintenanceWindow = TimeSpan.FromHours(5)
        }
    });

var scheduleCollection = cache.Value.GetRedisPatchSchedules();
await scheduleCollection.CreateOrUpdateAsync(
    WaitUntil.Completed,
    RedisPatchScheduleDefaultName.Default,
    scheduleData);

9. 导入/导出数据（Premium SKU）

// Import data from blob storage
var importContent = new ImportRdbContent(
    files: new[] { "https://mystorageaccount.blob.core.windows.net/container/dump.rdb" },
    format: "RDB");

await cache.Value.ImportDataAsync(WaitUntil.Completed, importContent);

// Export data to blob storage
var exportContent = new ExportRdbContent(
    prefix: "backup",
    container: "https://mystorageaccount.blob.core.windows.net/container?sastoken",
    format: "RDB");

await cache.Value.ExportDataAsync(WaitUntil.Completed, exportContent);

10. 强制重启

var rebootContent = new RedisRebootContent
{
    RebootType = RedisRebootType.AllNodes,
    ShardId = 0 // For clustered caches
};

await cache.Value.ForceRebootAsync(rebootContent);

SKU 参考

容量规格（系列 C - Basic/Standard）：

• C0：250 MB
• C1：1 GB
• C2：2.5 GB
• C3：6 GB
• C4：13 GB
• C5：26 GB
• C6：53 GB

容量规格（系列 P - Premium）：

• P1：每分片 6 GB
• P2：每分片 13 GB
• P3：每分片 26 GB
• P4：每分片 53 GB
• P5：每分片 120 GB

关键类型参考

最佳实践

1. 使用 WaitUntil.Completed 用于必须在继续之前完成的操作
2. 使用 WaitUntil.Started 当你想手动轮询或并行运行操作时
3. 始终使用 DefaultAzureCredential — 切勿硬编码密钥
4. 处理 RequestFailedException 用于 ARM API 错误
5. 使用 CreateOrUpdateAsync 实现幂等操作
6. 通过 Get* 方法导航层级（例如 cache.GetRedisFirewallRules()）
7. 生产工作负载使用 Premium SKU 需要异地复制、集群或持久化时
8. 启用 TLS 1.2 最低版本 — 设置 MinimumTlsVersion = RedisTlsVersion.Tls1_2
9. 禁用非 SSL 端口 — 设置 EnableNonSslPort = false 以确保安全
10. 定期轮换密钥 — 使用 RegenerateKeyAsync 并更新连接字符串

错误处理

using Azure;

try
{
    var operation = await cacheCollection.CreateOrUpdateAsync(
        WaitUntil.Completed, cacheName, cacheData);
}
catch (RequestFailedException ex) when (ex.Status == 409)
{
    Console.WriteLine("Cache already exists");
}
catch (RequestFailedException ex) when (ex.Status == 400)
{
    Console.WriteLine($"Invalid configuration: {ex.Message}");
}
catch (RequestFailedException ex)
{
    Console.WriteLine($"ARM Error: {ex.Status} - {ex.ErrorCode}: {ex.Message}");
}

常见陷阱

1. 不允许 SKU 降级 — 无法从 Premium 降级到 Standard/Basic
2. 集群需要 Premium — 分片配置仅在 Premium SKU 上可用
3. 异地复制需要 Premium — 链接服务器仅适用于 Premium 缓存
4. VNet 注入需要 Premium — 虚拟网络支持仅限 Premium
5. 补丁计划需要 Premium — 维护窗口仅在 Premium 上可配置
6. 缓存名称全局唯一 — Redis 缓存名称在所有 Azure 订阅中必须唯一
7. 预配时间较长 — 缓存创建可能需要 15-20 分钟；使用 WaitUntil.Started 实现异步模式

使用 StackExchange.Redis 连接（数据平面）

使用此管理 SDK 创建缓存后，使用 StackExchange.Redis 进行数据操作：

using StackExchange.Redis;

// Get connection info from management SDK
var cache = await resourceGroup.Value.GetRedisAsync("my-redis-cache");
var keys = await cache.Value.GetKeysAsync();

// Connect with StackExchange.Redis
var connectionString = $"{cache.Value.Data.HostName}:{cache.Value.Data.SslPort},password={keys.Value.PrimaryKey},ssl=True,abortConnect=False";
var connection = ConnectionMultiplexer.Connect(connectionString);
var db = connection.GetDatabase();

// Data operations
await db.StringSetAsync("key", "value");
var value = await db.StringGetAsync("key");

相关 SDK

何时使用

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

限制

• 仅当任务明确匹配上述范围时使用本技能。
• 不要将输出视为环境特定验证、测试或专家审查的替代品。
• 如果缺少所需的输入、权限、安全边界或成功标准，请停下来请求澄清。