QueueDetailsCommand.cs•3.76 kB
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using Azure.Messaging.ServiceBus;
using AzureMcp.Core.Commands;
using AzureMcp.Core.Commands.Subscription;
using AzureMcp.Core.Services.Telemetry;
using AzureMcp.ServiceBus.Models;
using AzureMcp.ServiceBus.Options;
using AzureMcp.ServiceBus.Options.Queue;
using AzureMcp.ServiceBus.Services;
using Microsoft.Extensions.Logging;
namespace AzureMcp.ServiceBus.Commands.Queue;
public sealed class QueueDetailsCommand(ILogger<QueueDetailsCommand> logger) : SubscriptionCommand<BaseQueueOptions>
{
private const string CommandTitle = "Get Service Bus Queue Details";
private readonly Option<string> _queueOption = ServiceBusOptionDefinitions.Queue;
private readonly Option<string> _namespaceOption = ServiceBusOptionDefinitions.Namespace;
private readonly ILogger<QueueDetailsCommand> _logger = logger;
public override string Name => "details";
public override string Description =>
"""
Get details about a Service Bus queue. Returns queue properties and runtime information. Properties returned include
lock duration, max message size, queue size, creation date, status, current message counts, etc.
Required arguments:
- namespace: The fully qualified Service Bus namespace host name. (This is usually in the form <namespace>.servicebus.windows.net)
- queue: Queue name to get details and runtime information for.
""";
public override string Title => CommandTitle;
public override ToolMetadata Metadata => new() { Destructive = false, ReadOnly = true };
protected override void RegisterOptions(Command command)
{
base.RegisterOptions(command);
command.AddOption(_namespaceOption);
command.AddOption(_queueOption);
}
protected override BaseQueueOptions BindOptions(ParseResult parseResult)
{
var options = base.BindOptions(parseResult);
options.Name = parseResult.GetValueForOption(_queueOption);
options.Namespace = parseResult.GetValueForOption(_namespaceOption);
return options;
}
public override async Task<CommandResponse> ExecuteAsync(CommandContext context, ParseResult parseResult)
{
var options = BindOptions(parseResult);
try
{
if (!Validate(parseResult.CommandResult, context.Response).IsValid)
{
return context.Response;
}
var service = context.GetService<IServiceBusService>();
var details = await service.GetQueueDetails(
options.Namespace!,
options.Name!,
options.Tenant,
options.RetryPolicy);
context.Response.Results = ResponseResult.Create(
new QueueDetailsCommandResult(details),
ServiceBusJsonContext.Default.QueueDetailsCommandResult);
}
catch (Exception ex)
{
_logger.LogError(ex, "Error getting Service Bus queue details");
HandleException(context, ex);
}
return context.Response;
}
protected override string GetErrorMessage(Exception ex) => ex switch
{
ServiceBusException exception when exception.Reason == ServiceBusFailureReason.MessagingEntityNotFound =>
$"Queue not found. Please check the queue name and try again.",
_ => base.GetErrorMessage(ex)
};
protected override int GetStatusCode(Exception ex) => ex switch
{
ServiceBusException sbEx when sbEx.Reason == ServiceBusFailureReason.MessagingEntityNotFound => 404,
_ => base.GetStatusCode(ex)
};
internal record QueueDetailsCommandResult(QueueDetails QueueDetails);
}