Azure Storage Queue

Create and Manage Azure Storage Queues and Messages.
This integration was integrated and tested with version “2020-10-02” of Azure Storage Queue

Configure Azure Storage Queue in Cortex

Shared Access Signatures (SAS) Permissions

In order to use the integration use-cases,
please make sure your SAS token contains the following permissions:

1. ‘Queue’ service.
2. ‘Service’ and ‘Object’ resource types.
3. ‘Read’, ‘Write’, ‘Delete’, ‘List’, ‘Create’, ‘Add’, ‘Update’, ‘Process’ and ‘Immutable storage’ permissions.

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

azure-storage-queue-list

List queues in storage account.

Base Command

azure-storage-queue-list

Input

Context Output

Command Example

!azure-storage-queue-list limit="2" prefix="xs"

Context Example

{
    "AzureStorageQueue": {
        "Queue": [
            {
                "name": "xsoar-new-test"
            },
            {
                "name": "xsoar-test"
            }
        ]
    }
}

Human Readable Output

Queues List

Current page size: 2
Showing page 1 out others that may exist

Name
xsoar-new-test
xsoar-test

azure-storage-queue-create

Create new queue in storage account.

Base Command

azure-storage-queue-create

Input

Context Output

There is no context output for this command.

Command Example

!azure-storage-queue-create queue_name="xsoar-test"

Human Readable Output

Queue xsoar-test successfully created.

azure-storage-queue-delete

Delete queue from storage account.

Base Command

azure-storage-queue-delete

Input

Context Output

There is no context output for this command.

Command Example

!azure-storage-queue-delete queue_name="xsoar-test"

Human Readable Output

Queue xsoar-test successfully deleted.

azure-storage-queue-message-create

Add a new message to the back of the queue.

Base Command

azure-storage-queue-message-create

Input

Context Output

Command Example

!azure-storage-queue-message-create message_content="test demo" queue_name="xsoar-test" base64_encoding="True"

Context Example

{
    "AzureStorageQueue": {
        "Queue": {
            "Message": {
                "ExpirationTime": "2021-12-05T11:55:31",
                "InsertionTime": "2021-11-28T11:55:31",
                "MessageId": "0d579602-222f-4256-9003-8772f0d65399",
                "PopReceipt": "AgAAAAMAAAAAAAAAN734107k1wE=",
                "TimeNextVisible": "2021-11-28T11:55:31"
            },
            "name": "xsoar-test"
        }
    }
}

Human Readable Output

xsoar-test Queue message

Message Id	Expiration Time	Insertion Time	Time Next Visible	Pop Receipt
0d579602-222f-4256-9003-8772f0d65399	2021-12-05T11:55:31	2021-11-28T11:55:31	2021-11-28T11:55:31	AgAAAAMAAAAAAAAAN734107k1wE=

azure-storage-queue-message-get

Retrieves messages from the front of the queue. Retrieved messages will move to the end of the queue,and will be visible after ‘TimeNextVisible’ param.

Base Command

azure-storage-queue-message-get

Input

Context Output

Command Example

!azure-storage-queue-message-get limit="1" queue_name="xsoar-test"

Context Example

{
    "AzureStorageQueue": {
        "Queue": {
            "Message": [
                {
                    "DequeueCount": "1",
                    "ExpirationTime": "2021-12-05T11:55:31",
                    "InsertionTime": "2021-11-28T11:55:31",
                    "MessageId": "0d579602-222f-4256-9003-8772f0d65399",
                    "MessageText": "test demo",
                    "PopReceipt": "AgAAAAMAAAAAAAAAziUx7U7k1wE=",
                    "TimeNextVisible": "2021-11-28T11:56:06"
                }
            ],
            "name": "xsoar-test"
        }
    }
}

Human Readable Output

xsoar-test Queue messages

Message Text	Message Id	Pop Receipt	Dequeue Count	Expiration Time	Insertion Time	Time Next Visible
test demo	0d579602-222f-4256-9003-8772f0d65399	AgAAAAMAAAAAAAAAziUx7U7k1wE=	1	2021-12-05T11:55:31	2021-11-28T11:55:31	2021-11-28T11:56:06

azure-storage-queue-message-peek

Retrieves messages from the front of the queue. The command does not alter the visibility of the message.

Base Command

azure-storage-queue-message-peek

Input

Context Output

Command Example

!azure-storage-queue-message-peek limit="1" queue_name="xsoar-test"

Context Example

{
    "AzureStorageQueue": {
        "Queue": {
            "Message": [],
            "name": "xsoar-test"
        }
    }
}

Human Readable Output

xsoar-test Queue messages

No entries.

azure-storage-queue-message-dequeue

Dequeue a message from the front of the queue.

Base Command

azure-storage-queue-message-dequeue

Input

Context Output

There is no context output for this command.

Command Example

!azure-storage-queue-message-dequeue queue_name="xsoar-test"

Human Readable Output

There are no messages in xsoar-test queue.

azure-storage-queue-message-update

Update message content in the queue.

Base Command

azure-storage-queue-message-update

Input

Context Output

There is no context output for this command.

Command Example

!azure-storage-queue-message-update queue_name="test-xsoar" message_content="new content" message_id="ea0db196-dad3-4c12-b845-dc6223739870" pop_receipt="AgAAAAMAAAAAAAAA0xNSmE7k1wE="

Human Readable Output

The message in test-xsoar successfully updated.

azure-storage-queue-message-delete

Delete message from a Queue.

Base Command

azure-storage-queue-message-delete

Input

Context Output

There is no context output for this command.

Command Example

!azure-storage-queue-message-delete queue_name="test-xsoar" message_id="66df94e9-4a66-428a-9c4a-e2a3c4fe7284" pop_receipt="AgAAAAMAAAAAAAAA0xNSmE7k1wE="

Human Readable Output

Message in test-xsoar successfully deleted.

azure-storage-queue-message-clear

Delete all messages from the specified Queue.

Base Command

azure-storage-queue-message-clear

Input

Context Output

There is no context output for this command.

Command Example

!azure-storage-queue-message-clear queue_name="xsoar-test"

Human Readable Output

xsoar-test was cleared of messages successfully.