Skip to content

Commit 556378b

Browse files
authored
Update documentation for Service Bus namespace. Comment out peek commands. (#209)
* Update documenttion for namespace * Add space in host name * Add changelog * Comment out peek commnd
1 parent 175fba3 commit 556378b

File tree

8 files changed

+14
-8
lines changed

8 files changed

+14
-8
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Release History
22

3+
## 0.0.19 (Unreleased)
4+
5+
### Bugs Fixed
6+
7+
- Fixes Service Bus host name parameter description. https://github.com/Azure/azure-mcp/pull/209/
8+
39
## 0.0.18 (2025-05-14)
410

511
### Bugs Fixed

src/Commands/CommandFactory.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -348,14 +348,14 @@ private void RegisterServiceBusCommands()
348348
_rootGroup.AddSubGroup(serviceBus);
349349

350350
var queue = new CommandGroup("queue", "Queue operations - Commands for using Azure Service Bus queues.");
351-
queue.AddCommand("peek", new ServiceBus.Queue.QueuePeekCommand());
351+
// queue.AddCommand("peek", new ServiceBus.Queue.QueuePeekCommand());
352352
queue.AddCommand("details", new ServiceBus.Queue.QueueDetailsCommand());
353353

354354
var topic = new CommandGroup("topic", "Topic operations - Commands for using Azure Service Bus topics and subscriptions.");
355355
topic.AddCommand("details", new ServiceBus.Topic.TopicDetailsCommand());
356356

357357
var subscription = new CommandGroup("subscription", "Subscription operations - Commands for using subscriptions within a Service Bus topic.");
358-
subscription.AddCommand("peek", new ServiceBus.Topic.SubscriptionPeekCommand());
358+
// subscription.AddCommand("peek", new ServiceBus.Topic.SubscriptionPeekCommand());
359359
subscription.AddCommand("details", new ServiceBus.Topic.SubscriptionDetailsCommand());
360360

361361
serviceBus.AddSubGroup(queue);

src/Commands/ServiceBus/Queue/QueueDetailsCommand.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Get details about a Service Bus queue. Returns queue properties and runtime info
2626
lock duration, max message size, queue size, creation date, status, current message counts, etc.
2727
2828
Required arguments:
29-
- namespace: Service Bus namespace name. (This is usually in the form <namespace>.servicebus.windows.net)
29+
- namespace: The fully qualified Service Bus namespace host name. (This is usually in the form <namespace>.servicebus.windows.net)
3030
- queue-name: Queue name to get details and runtime information for.
3131
""";
3232

src/Commands/ServiceBus/Queue/QueuePeekCommand.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ protected override string GetCommandDescription() =>
2929
Returns message content, properties, and metadata. Messages remain in the queue after peeking.
3030
3131
Required arguments:
32-
- namespace: Service Bus namespace name. (This is usually in the form <namespace>.servicebus.windows.net)
32+
- namespace: The fully qualified Service Bus namespace host name. (This is usually in the form <namespace>.servicebus.windows.net)
3333
- queue: Queue name to peek messages from
3434
""";
3535

src/Commands/ServiceBus/Topic/SubscriptionDetailsCommand.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ protected override string GetCommandDescription() =>
2626
Get details about a Service Bus subscription. Returns subscription runtime properties including message counts, delivery settings, and other metadata.
2727
2828
Required arguments:
29-
- namespace: Service Bus namespace name. (This is usually in the form <namespace>.servicebus.windows.net)
29+
- namespace: The fully qualified Service Bus namespace host name. (This is usually in the form <namespace>.servicebus.windows.net)
3030
- topic-name: Topic name containing the subscription
3131
- subscription-name: Name of the subscription to get details for
3232
""";

src/Commands/ServiceBus/Topic/SubscriptionPeekCommand.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ protected override string GetCommandDescription() =>
3030
Returns message content, properties, and metadata. Messages remain in the subscription after peeking.
3131
3232
Required arguments:
33-
- namespace: Service Bus namespace name. (This is usually in the form <namespace>.servicebus.windows.net)
33+
- namespace: The fully qualified Service Bus namespace host name. (This is usually in the form <namespace>.servicebus.windows.net)
3434
- topic-name: Topic name containing the subscription
3535
- subscription-name: Subscription name to peek messages from
3636
""";

src/Commands/ServiceBus/Topic/TopicDetailsCommand.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Get details about a Service Bus topic. Returns topic properties and runtime info
2626
number of subscriptions, max message size, max topic size, number of scheduled messages, etc.
2727
2828
Required arguments:
29-
- namespace: Service Bus namespace name. (This is usually in the form <namespace>.servicebus.windows.net)
29+
- namespace: The fully qualified Service Bus namespace host name. (This is usually in the form <namespace>.servicebus.windows.net)
3030
- topic-name: Topic name to get information about.
3131
""";
3232

src/Models/Argument/ArgumentDefinitions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -449,7 +449,7 @@ public static class ServiceBus
449449

450450
public static readonly ArgumentDefinition<string> Namespace = new(
451451
NamespaceName,
452-
"The Service Bus namespace name.",
452+
"The fully qualified Service Bus namespace host name. (This is usually in the form <namespace>.servicebus.windows.net)",
453453
required: true);
454454

455455
public static readonly ArgumentDefinition<string> Queue = new(

0 commit comments

Comments
 (0)