AzureServiceBusQueueHealthCheckOptions.cs

namespace HealthChecks.AzureServiceBus.Configuration;

/// <summary>
/// Configuration options for <see cref="AzureServiceBusQueueHealthCheck"/>.
/// </summary>
public class AzureServiceBusQueueHealthCheckOptions : AzureServiceBusHealthCheckOptions
{
    /// <summary>
    /// The name of the queue to check.
    /// </summary>
    public string QueueName { get; set; }

    /// <summary>
    /// Will use <c>PeekMessageAsync</c> method to determine status if set to <see langword="true"/> (default),
    /// otherwise; will use <c>GetProperties*</c> method.
    /// </summary>
    /// <remarks>
    /// Peek requires Listen claim to work. However, if only Sender claim using the Azure built-in roles (RBAC)
    /// <see href="https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#azure-service-bus-data-sender">Azure Service Bus Data Sender</see>
    /// is used set this to <see langword="false"/>. By default <see langword="true"/>.
    /// </remarks>
    public bool UsePeekMode { get; set; } = true;

    /// <summary>
    /// Will use <c>CreateMessageBatchAsync</c> method to determine status if set to <see langword="true"/> (default),
    /// otherwise; will use <c>GetProperties*</c> method.
    /// </summary>
    /// <remarks>
    /// CreateMessageBatch requires Send claim to work. However, if only Receiver claim using the Azure built-in roles (RBAC)
    /// <see href="https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles/integration#azure-service-bus-data-receiver">Azure Service Bus Data Receiver</see>
    /// is used set this to <see langword="false"/>. By default <see langword="true"/>.
    /// </remarks>
    public bool UseCreateMessageBatchAsyncMode { get; set; } = true;

    public AzureServiceBusQueueHealthCheckOptions(string queueName)
    {
        QueueName = queueName;
    }
}