Azure Queue Explorer

Posted : admin On 1/29/2022
  1. Azure Queue Explorer Download
  2. Azure Cloud Queue
Queue-->

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. Use Azure Queue Storage to build flexible applications and separate functions for better durability across large workloads. When you design applications for scale, application components can be decoupled, so that they can scale independently.

Overview

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.

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 -

  1. Pick the Content Type to be either 'Text/Plain', 'Application/Xml' or 'Application/Json'.
  2. Add the message Content. Ensure that it matches the Content Type set earlier.
  3. Set the Advanced Properties (optional) - these include Correlation ID, Message ID, Label, ReplyTo, Time to Live (TTL) and Scheduled Enqueue Time (for Scheduled Messages).
  4. 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)

  1. Click on the Receive tab on the Service Bus Explorer.

  2. Check the metrics to see if there are Active Messages or Dead-lettered Messages to receive.

  3. Pick between the Queue or the Deadletter subqueue.

  4. 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.

  1. To peek the message on a queue, click on the Peek tab on the Service Bus Explorer.

  2. Check the metrics to see if there are Active Messages or Dead-lettered Messages to peek.

  3. Then pick between the Queue or the Deadletter subqueue.

  4. Click the Peek button.

Azure storage explorer clear queue

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

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.

  1. Click on the Receive tab and select the specific Subscription from the dropdown selector.

  2. Pick between the Subscription or the DeadLetter sub-entity.

  3. 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

Azure Queue Explorer Download

To simply browse the messages on a Subscription or its deadletter sub-entity, the Peek functionality can be utilized on the Subscription as well.

  1. Click on the Peek tab and select the specific Subscription from the dropdown selector.

  2. Pick between the Subscription or the DeadLetter subentity.

  3. Click the Peek button.

Azure Queue Explorer

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

Storage accounts provide a flexible solution that keeps data as files, tables, and messages. With Azure Storage Explorer, it's easy to read and manipulate this data.

You want to enable your engineers to manage the data stored in Azure Storage, so they can maintain the data that your CRM application uses. You want to assess whether they can use Storage Explorer for this purpose.

Here, you'll learn about Storage Explorer, and how you can use it to manage data from multiple storage accounts and subscriptions. You'll learn different ways of using Storage Explorer to connect to your data, Azure Stack, and data held in Azure Cosmos DB and Azure Data Lake.

What is Storage Explorer?

Storage Explorer is a GUI application developed by Microsoft to simplify access to, and the management of, data stored in Azure storage accounts. Storage Explorer is available on Windows, macOS, and Linux.

Some of the benefits of using Storage Explorer are:

  • It's easy to connect to and manage multiple storage accounts.
  • The interface lets you connect to Azure Cosmos DB and Data Lake.
  • You can also use the interface to update and view entities in your storage accounts.
  • Storage Explorer is free to download and use.

With Storage Explorer, you can use a range of storage and data operation tasks on any of your Azure storage accounts. These tasks include edit, download, copy, and delete.

Supported software versions

Queue

The Azure Storage Explorer application runs on the following versions of these platforms:

SUPPORTED SOFTWARE VERSIONS
Operating systemVersion
WindowsWindows 10 (Recommended), Windows 8, or Windows 7
macOSmacOS 12.12 Sierra and later
LinuxUbuntu 18.04 x64, Ubuntu16.04 x64, or Ubuntu 14.04 x64

Azure Storage types

Azure Storage Explorer can access many different data types from services like these:

  • Azure Blob storage. Blob storage is used to store unstructured data as a binary large object (blob).
  • Azure Table storage. Table storage is used to store NoSQL, semi-structured data.
  • Azure Files. Azure File is a file-sharing service that enables access through the Server Message Block protocol, similar to traditional file servers.
  • Azure Data Lake Storage. Azure Data Lake, based on Apache Hadoop, is designed for large data volumes and can store unstructured and structured data.

Manage multiple storage accounts in multiple subscriptions

If you have multiple storage accounts across multiple subscriptions in your Azure tenant, managing them through the Azure portal can be time-consuming. Storage Explorer gives you the ability to manage the data stored in multiple Azure storage accounts and across Azure subscriptions.

Use local emulators

During the development phase of your project, you might not want developers to incur additional costs by using Azure storage accounts. In those cases, you can use a locally based emulator. Storage Explorer supports two emulators: Azure Storage Emulator and Azurite.

  • Azure Storage Emulator uses a local instance of Microsoft SQL Server 2012 Express LocalDB. It emulates the Azure Table, Queue, and Blob storage.
  • Azurite, which is based on Node.js, is an open-source emulator that supports most Azure Storage commands through an API.

Storage Explorer requires the emulator to be running before you open it. Connecting to your emulator is no different from connecting to Azure storage accounts. However, you'll choose the Attach to a local emulator connection type.

All locally emulated storage connection types appear in Local & Attached > Storage accounts.

Connecting Storage Explorer to Azure

There are several ways to connect your Storage Explorer application to your Azure storage accounts.

You need two permissions to access your Azure storage account: management and data. However, you can use Storage Explorer with only there prompted, provide the type of resource that you're connecting to.

  • Review and verify the connection details, and then select Connect.
  • It's crucial to select the correct resource type because it changes the information that you need to enter.

    Any connections that you create through this approach will appear in the resource tree, in this branch: Local & attached > Storage Accounts > Attached Containers > Blob.

    Connect by using a shared access signature URI

    A shared access signature (SAS) URI is an unambiguous identifier that's used to access your Azure Storage resources.

    With this connection method, you'll use a SAS URI for the required storage account. You'll need a SAS URI whether you want to use a file share, table, queue, or blob container. You can get a SAS URI either from the Azure portal or from Storage Explorer.

    Azure Cloud Queue

    To add a SAS connection:

    1. Open Storage Explorer.
    2. Connect to your Azure storage account.
    3. Select the connection type: shared access signature (SAS) URI.
    4. Provide a meaningful name for the connection.
    5. When you're prompted, provide the SAS URI.
    6. Review and verify the connection details, and then select Connect.

    When you've added a connection, it appears in the resource tree as a new node. You'll find the connection node in this branch: Local & attached > Storage Accounts > Attached Container > Service.

    Connect by using a storage account name and key

    To connect to a storage account on Azure quickly, you use the account key that's associated with the storage. To find the storage access keys from the Azure portal, go to the correct storage account page and select access keys.

    To add a connection:

    1. Open Storage Explorer.
    2. Connect to your Azure storage account.
    3. Select the connection type: storage account name and key.
    4. Provide a meaningful name for the connection.
    5. When you're prompted, provide the name of the storage account and either of the account keys needed to access it.
    6. From the provided list, select the storage domain that you want to use.
    7. Review and verify the connection details, and then select Connect.

    When the connection is added, it appears in the resource tree as a connection node. The connection node is in this branch: Local & attached > Storage Accounts.

    Manage Azure Cosmos DB and Data Lake

    You can use Storage Explorer to access and manage data stored in Azure Cosmos DB and Data Lake.

    To connect to an Azure Cosmos DB service, you'll need to use a connection string. You get a connection string by accessing the Azure Cosmos DB configuration through the Azure portal.

    To connect to a Data Lake service, you'll need the URI associated with the data lake. Presently, Storage Explorer supports only Data Lake Storage Gen1. Data Lake Storage Gen2 is currently in preview, and support will be available through Storage Explorer. Using a URI allows you to access resources that aren't in your subscription. When you have the URI of the resource that you want to access, you connect to it by using the Data Lake Storage Gen1 option.