Implement health checks for Azure Key Vault CertificateClient and KeyClient

src/Components/Aspire.Azure.Security.KeyVault/AzureKeyVaultCertificatesComponent.cs

@@ -20,11 +20,8 @@ internal sealed class AzureKeyVaultCertificatesComponent : AbstractAzureKeyVault
     internal override CertificateClient CreateComponentClient(Uri vaultUri, CertificateClientOptions options, TokenCredential cred)
         => new(vaultUri, cred, options);
 
-    protected override bool GetHealthCheckEnabled(AzureSecurityKeyVaultSettings settings)
-        => false;
-
     protected override IHealthCheck CreateHealthCheck(CertificateClient client, AzureSecurityKeyVaultSettings settings)
-        => throw new NotImplementedException();
+        => new AzureKeyVaultCertificatesHealthCheck(client);
 
     protected override void BindClientOptionsToConfiguration(IAzureClientBuilder<CertificateClient, CertificateClientOptions> clientBuilder, IConfiguration configuration)
 #pragma warning disable IDE0200 // Remove unnecessary lambda expression - needed so the ConfigBinder Source Generator works

src/Components/Aspire.Azure.Security.KeyVault/AzureKeyVaultCertificatesHealthCheck.cs

@@ -0,0 +1,32 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Azure.Security.KeyVault.Certificates;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+
+namespace Aspire.Azure.Security.KeyVault;
+
+internal sealed class AzureKeyVaultCertificatesHealthCheck : IHealthCheck
+{
+    private readonly CertificateClient _client;
+
+    public AzureKeyVaultCertificatesHealthCheck(CertificateClient client)
+        => _client = client;
+
+    public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)
+    {
+        try
+        {
+            await foreach (var _ in _client.GetPropertiesOfCertificatesAsync(cancellationToken: cancellationToken).AsPages(pageSizeHint: 1).WithCancellation(cancellationToken).ConfigureAwait(false))
+            {
+                break;
+            }
+
+            return HealthCheckResult.Healthy();
+        }
+        catch (Exception ex)
+        {
+            return new HealthCheckResult(context.Registration.FailureStatus, exception: ex);
+        }
+    }
+}

src/Components/Aspire.Azure.Security.KeyVault/AzureKeyVaultKeysComponent.cs

@@ -13,11 +13,8 @@ namespace Microsoft.Extensions.Hosting;
 
 internal sealed class AzureKeyVaultKeysComponent : AbstractAzureKeyVaultComponent<KeyClient, KeyClientOptions>
 {
-    protected override bool GetHealthCheckEnabled(AzureSecurityKeyVaultSettings settings)
-        => false;
-
     protected override IHealthCheck CreateHealthCheck(KeyClient client, AzureSecurityKeyVaultSettings settings)
-        => throw new NotImplementedException();
+        => new AzureKeyVaultKeysHealthCheck(client);
 
     internal override KeyClient CreateComponentClient(Uri vaultUri, KeyClientOptions options, TokenCredential cred)
         => new(vaultUri, cred, options);

src/Components/Aspire.Azure.Security.KeyVault/AzureKeyVaultKeysHealthCheck.cs

@@ -0,0 +1,32 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Azure.Security.KeyVault.Keys;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+
+namespace Aspire.Azure.Security.KeyVault;
+
+internal sealed class AzureKeyVaultKeysHealthCheck : IHealthCheck
+{
+    private readonly KeyClient _client;
+
+    public AzureKeyVaultKeysHealthCheck(KeyClient client)
+        => _client = client;
+
+    public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)
+    {
+        try
+        {
+            await foreach (var _ in _client.GetPropertiesOfKeysAsync(cancellationToken).AsPages(pageSizeHint: 1).WithCancellation(cancellationToken).ConfigureAwait(false))
+            {
+                break;
+            }
+
+            return HealthCheckResult.Healthy();
+        }
+        catch (Exception ex)
+        {
+            return new HealthCheckResult(context.Registration.FailureStatus, exception: ex);
+        }
+    }
+}

tests/Aspire.Azure.Security.KeyVault.Tests/CertificateClientConformanceTests.cs

@@ -88,9 +88,7 @@ void ConfigureCredentials(AzureSecurityKeyVaultSettings settings)
     }
 
     protected override void SetHealthCheck(AzureSecurityKeyVaultSettings options, bool enabled)
-    // Disable Key Vault health check tests until https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/issues/2279 is fixed
-    //    => options.DisableHealthChecks = !enabled;
-        => throw new NotImplementedException();
+        => options.DisableHealthChecks = !enabled;
 
     protected override void SetMetrics(AzureSecurityKeyVaultSettings options, bool enabled)
         => throw new NotImplementedException();

tests/Aspire.Azure.Security.KeyVault.Tests/KeyClientConformanceTests.cs

@@ -90,9 +90,7 @@ void ConfigureCredentials(AzureSecurityKeyVaultSettings settings)
     }
 
     protected override void SetHealthCheck(AzureSecurityKeyVaultSettings options, bool enabled)
-    // Disable Key Vault health check tests until https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/issues/2279 is fixed
-    //    => options.DisableHealthChecks = !enabled;
-        => throw new NotImplementedException();
+        => options.DisableHealthChecks = !enabled;
 
     protected override void SetMetrics(AzureSecurityKeyVaultSettings options, bool enabled)
         => throw new NotImplementedException();