-->
Overview
This is a vscode extension to send message to or monitor messages in Azure Event Hub. Features x Select Event Hub x Send messages to Event Hub x Monitor Event Hub messages. Azure Storage Explorer is a tool that helps us to easily work with Azure storage data on different platform such as windows, macOS, and Linux. We can connect to our subscription and manipulate our queues, files, tables, and blobs using this tool. Additionally, we can also manipulate Azure Cosmos DB Storage and Azure Data Lake Storage using this. GitHub - microsoft/AzureStorageExplorer: Easily manage the contents of your storage account with Azure Storage Explorer. Upload, download, and manage blobs, files, queues, tables, and Cosmos DB entities. Gain easy access to manage your virtual machine disks. Kjoshi-rubikloud changed the title Storage Explorer only shows 32 messages in Azure Queue Storage Explorer only shows up to 32 messages in Azure Queue on Apr 25, 2018 MRayermannMSFT added the feature request label on Apr 26, 2018 MRayermannMSFT closed this on Aug 9, 2018 MRayermannMSFT added the by design label on Aug 9, 2018.
Azure Service Bus allows sender and receiver client applications to decouple their business logic with the use of familiar point-to-point (Queue) and publish-subscribe (Topic-Subscription) semantics.
Operations performed on an Azure Service Bus namespace are of two kinds
- Management Operations - Create, Update, Delete of Service Bus Namespace, Queues, Topics, and Subscriptions.
- Data Operations - Send to and Receive Messages from Queues, Topics, and Subscriptions.
The Azure Service Bus Explorer expands the portal functionality beyond the management operations to support data operations (Send, Receive, Peek) on the Queues, Topics, and Subscriptions (and their dead letter subentities) - right from the Azure portal itself.
Note
This article highlights the functionality of the Azure Service Bus Explorer that lives on the Azure portal.
The Azure Service Bus explorer tool is not the community owned OSS tool Service Bus Explorer.
Prerequisites
To use the Service Bus Explorer tool, you will need to do the following tasks:
- Provision an Azure Service Bus namespace.
- Create a queue to send and receive message from or a topic with a subscription to test out the functionality. To learn how to create queues, topics and subscriptions, see the following articles:
- Ensure that you are a member of one of these roles on the namespace:
Using the Service Bus Explorer
To use the Azure Service Bus explorer, you need to navigate to the Service Bus namespace on which you want to perform send, peek, and receive operations.
If you are looking to perform operations against a Queue, pick 'Queues' from the navigation menu. If you are looking to perform operations against a Topic (and it's related subscriptions), pick Topics.
After picking the 'Queues' or 'Topics', pick the specific Queue or Topic.
Select the 'Service Bus Explorer (preview)' from the left navigation menu
Sending a message to a Queue or Topic
To send a message to a Queue or a Topic, click on the Send tab on the Service Bus Explorer.
To compose a message here -
- Pick the Content Type to be either 'Text/Plain', 'Application/Xml' or 'Application/Json'.
- Add the message Content. Ensure that it matches the Content Type set earlier.
- Set the Advanced Properties (optional) - these include Correlation ID, Message ID, Label, ReplyTo, Time to Live (TTL) and Scheduled Enqueue Time (for Scheduled Messages).
- Set the Custom Properties - can be any user properties set against a dictionary key.
Once the message has been composed, hit send.
When the send operation is completed successfully,
If sending to the Queue, Active Messages metrics counter will increment.
If sending to the Topic, Active Messages metrics counter will increment on the Subscription where the message was routed to.
Receiving a message from a Queue
The receive function on the Service Bus Explorer permits receiving a single message at a time. The receive operation is performed using the ReceiveAndDelete mode.
Important
Please note that the Receive operation performed by the Service Bus explorer is a destructive receive, i.e. the message is removed from the queue when it is displayed on the Service Bus Explorer tool.
To browse messages without removing them from the queue, consider using the Peek functionality.
To receive a message from a Queue (or its deadletter subqueue)
Click on the Receive tab on the Service Bus Explorer.
Check the metrics to see if there are Active Messages or Dead-lettered Messages to receive.
Pick between the Queue or the Deadletter subqueue.
Click the Receive button, followed by Yes to confirm the 'Receive and Delete' operation.
When the receive operation is successful, the message details will display on the grid as below. You can select the message from the grid to display its details.
Peeking a message from a Queue
With the peek functionality, you can use the Service Bus Explorer to view the top 32 messages on a queue or the deadletter queue.
To peek the message on a queue, click on the Peek tab on the Service Bus Explorer.
Check the metrics to see if there are Active Messages or Dead-lettered Messages to peek.
Then pick between the Queue or the Deadletter subqueue.
Click the Peek button.
Once the peek operation completes, up to 32 messages will show up on the grid as below. To view the details of a particular message, select it from the grid.
Note
Since peek is not a destructive operation the message will not be removed from the queue.
Receiving a message from a Subscription
Azure Queue Services
Just like with a queue, the Receive operation can be performed against a subscription (or its deadletter entity). However, since a Subscription lives within the context of the Topic, the receive operation is performed by navigating to the Service Bus Explorer for a given Topic.
Important
Please note that the Receive operation performed by the Service Bus explorer is a destructive receive, i.e. the message is removed from the queue when it is displayed on the Service Bus Explorer tool.
To browse messages without removing them from the queue, consider using the Peek functionality.
Click on the Receive tab and select the specific Subscription from the dropdown selector.
Pick between the Subscription or the DeadLetter sub-entity.
Click the Receive button, followed by Yes to confirm the 'Receive and Delete' operation.
When the receive operation is successful, the received message will display on the grid as below. To view the message details, click on the message.
Peeking a message from a Subscription
To simply browse the messages on a Subscription or its deadletter sub-entity, the Peek functionality can be utilized on the Subscription as well.
Click on the Peek tab and select the specific Subscription from the dropdown selector.
Pick between the Subscription or the DeadLetter subentity.
Click the Peek button.
Once the peek operation completes, up to 32 messages will show up on the grid as below. To view the details of a particular message, select it from the grid.
Note
Since peek is not a destructive operation the message will not be removed from the queue.
Next Steps
- Learn more about Service Bus Queues and Topics
- Learn more about creating Service Bus Queues via the Azure portal
- Learn more about creating Service Bus Topics and Subscriptions via the Azure portal
- Microsoft Azure Tutorial
- Microsoft Azure Advanced
- Microsoft Azure Useful Resources
- Selected Reading
In the common language used by developers, a queue is a data structure used to store data which follows First in-First out rule. A data item can be inserted from back of the queue while it is retrieved from front. Azure queues are a very similar concept that is used to store the messages in a queue. A sender sends the message and a client receives and processes them. A message has few attributes attached to it, for example expiry time.
A client usually processes and deletes the message. Windows Azure service lets the message to be stored for 7 days and later it gets deleted automatically, if it is not deleted by the client. There can be one sender and one client or one sender and many clients or many sender and many clients.
There are two services offered by Windows Azure for message queues. This chapter covers Windows Azure queue. The other service is called ‘Service Bus queue’.
Decoupling the components is one of the advantages of message queue services. It runs in an asynchronous environment where messages can be sent among the different components of an application. Thus, it provides an efficient solution for managing workflows and tasks. For example, a message to complete a task is sent from the frontend of the application and is received by a backend worker, who then completes the task and deletes the message.
Considerations
The messages in the storage queue are not replicated anywhere, that means there is only one copy of your message. The maximum number of messages that can be processed are 20,000. The maximum size of a message can be 64 kb.
Managing Queues using PowerShell
Create a Queue
Step 1 − Right-click on Windows PowerShell in the taskbar. Choose ‘Run ISE as administrator’.
Step 2 − Run the following command to access your account. Please replace the highlighted part for your account.
Step 3 − Specify the storage account in which you want to create a queue.
Step 4 − Create a Queue.
Retrieve a Queue
Delete a Queue
Insert a Message into a Queue
Step 1 − Login to your account.
Step 2 − Specify the storage account you want to use.
Step 3 − Retrieve the queue and then insert the message.
The ‘if’ condition in the script above checks if the queue specified exists or not.
Dequeue Next Message from Queue
Azure Storage Explorer Clear Queue
Step 1 − First connect to your account and specify the storage account, by running the commands as shown in the above steps.
Step 2 − Retrieve the queue.
Step 3 − Dequeue the next message.
Step 4 − Delete the dequeued message.
Managing Queues using Azure Storage Explorer
Step 1 − Select the storage account from the dropdown at the top right. Accounts will be displayed if you have added them during your previous use. If not, you can add account and it will ask for your credentials. After signing in, you will be logged into your account in Azure Storage Explorer.
Step 2 − You can add a new queue by selecting ‘Queues’ from the left panel and clicking ‘New’ as shown in the following image.
Step 3 − Enter the name of Queue and it is created in your storage account.
Step 4 − Add and delete the messages by selecting the queue in the left panel.