frends-community - Frends.Community.Azure.QueueStorage 1.4.2

Task for Azure Storage Queue operations

PM> Install-Package Frends.Community.Azure.QueueStorage -Version 1.4.2 -Source https://www.myget.org/F/frends-community/api/v3/index.json

Copy to clipboard

> nuget.exe install Frends.Community.Azure.QueueStorage -Version 1.4.2 -Source https://www.myget.org/F/frends-community/api/v3/index.json

Copy to clipboard

> dotnet add package Frends.Community.Azure.QueueStorage --version 1.4.2 --source https://www.myget.org/F/frends-community/api/v3/index.json

Copy to clipboard 
<PackageReference Include="Frends.Community.Azure.QueueStorage" Version="1.4.2" />
Copy to clipboard 
source https://www.myget.org/F/frends-community/api/v3/index.json

nuget Frends.Community.Azure.QueueStorage  ~> 1.4.2
Copy to clipboard

> choco install Frends.Community.Azure.QueueStorage --version 1.4.2 --source https://www.myget.org/F/frends-community/api/v2

Copy to clipboard 
Import-Module PowerShellGet
Register-PSRepository -Name "frends-community" -SourceLocation "https://www.myget.org/F/frends-community/api/v2"
Install-Module -Name "Frends.Community.Azure.QueueStorage" -RequiredVersion "1.4.2" -Repository "frends-community"
Copy to clipboard

Frends.Community.Azure.QueueStorage

FRENDS community task for Azure Queue Storage operations

Installing

You can install the task via FRENDS UI Task View or you can find the nuget package from the following nuget feed 'Insert nuget feed here'

Tasks

CreateQueueAsync

Creates a new Queue in QueueStorage.

Properties

Property Type Description Example
Storage Connection String string Queue Storage Connection string. See Configure Azure Storage connection strings UseDevelopmentStorage=true;
Queue Name string Name of the created Queue. See Naming Queues and Metada for naming conventions. 'my-new-queue'
Throw Error On Failure bool If true exception is thrown in case of failure, otherwise returns Object true

Result

Property Type Description Example
Success boolean Task execution result. true
Info string Task result message. If Throw Exception on failure is false, contains error message. 'Queue 'my-queue' created.'

DeleteQueueAsync

Deletes a queue in QueueStorage.

Properties

Property Type Description Example
Storage Connection String string Queue Storage Connection string. See Configure Azure Storage connection strings UseDevelopmentStorage=true;
Queue Name string Name of the Queue you wish to delete. 'delete-this-queue'
Throw Error On Failure bool If true exception is thrown in case of failure, otherwise returns Object true

Result

Property Type Description Example
Success boolean Task execution result. true
Info string Task result message. If Throw Exception on failure is false, contains error message. 'Queue 'my-queue' deleted.'

GetQueueLengthAsync

Gets an estimate number of messages in a queue.

Properties

Property Type Description Example
Storage Connection String string Queue Storage Connection string. See Configure Azure Storage connection strings UseDevelopmentStorage=true;
Queue Name string Name of the Queue which message count is calculated. 'count-this-queue'
Throw Error On Failure bool If true exception is thrown in case of failure, otherwise returns Object true

Result

Property Type Description Example
Success boolean Task execution result. true
Info string Task result message. If Throw Exception on failure is false, contains error message.
Count int The estimated number of messages in queue. 4

InsertMessageAsync

Inserts a new message to queue.

Properties

Property Type Description Example
Storage Connection String string Queue Storage Connection string. See Configure Azure Storage connection strings UseDevelopmentStorage=true;
Queue Name string Name of the Queue where message is added. 'add-message-queue'
Content string Message content. 'Hello QueueStorage!'
Create Queue bool Indicates if Queue should be created in case it does not exist. true
Throw Error On Failure bool If true exception is thrown in case of failure, otherwise returns Object true

Result

Property Type Description Example
Success boolean Task execution result. true
Info string Task result message. If Throw Exception on failure is false, contains error message. 'Message added to queue 'my-queue'.'

DeleteMessageAsync

Removes next message from queue.

Properties

Property Type Description Example
Storage Connection String string Queue Storage Connection string. See Configure Azure Storage connection strings UseDevelopmentStorage=true;
Queue Name string Name of the Queue from where message is deleted. 'remove-message-queue'
Throw Error On Failure bool If true exception is thrown in case of failure, otherwise returns Object true

Result

Property Type Description Example
Success boolean Task execution result. true
Info string Task result message. If Throw Exception on failure is false, contains error message. 'Deleted next message in queue 'my-queue'.'

PeekNextMessageAsync

Peeks at the message in front of the queue and returns its content.

Properties

Property Type Description Example
Storage Connection String string Queue Storage Connection string. See Configure Azure Storage connection strings UseDevelopmentStorage=true;
Queue Name string Name of the Queue from where message is peeked. 'peek-message-queue'
Throw Error On Failure bool If true exception is thrown in case of failure, otherwise returns Object true

Result

Property Type Description Example
Success boolean Task execution result. true
Info string If Task fails, contains error information
Content string Content of the message in front of the queue 'some content.'

Building

Clone a copy of the repo

git clone https://github.com/CommunityHiQ/Frends.Community.Azure.QueueStorage.git

Restore dependencies

dotnet restore Frends.Community.Azure.QueueStorage

Rebuild the project

Run Tests with dotnet test. Tests can be found under

dotnet test

Create a nuget package

dotnet pack -c Release

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Change Log

Version Changes
1.0.0 Initial version of Azure QueueStorage tasks
1.3.0 Dependency version fixes
1.4.2 Added support for .NET 6.0 and 8.0
  • .NETFramework 4.7.1
    • WindowsAzure.Storage (>= 9.3.3)
  • .NETFramework 6.0
    • WindowsAzure.Storage (>= 9.3.3)
  • .NETFramework 8.0
    • WindowsAzure.Storage (>= 9.3.3)
  • .NETStandard 2.0
    • WindowsAzure.Storage (>= 9.3.3)
  • .NETFramework 4.7.1: 4.7.1.0
  • .NETFramework 6.0: 6.0.0.0
  • .NETFramework 8.0: 8.0.0.0
  • .NETStandard 2.0: 2.0.0.0

Owners

FRENDS Community Feed User

Authors

HiQ Finland

Project URL

https://github.com/CommunityHiQ/Frends.Community.Azure.QueueStorage

License

Unknown

Info

61 total downloads
5 downloads for version 1.4.2
Download (28.93 KB)
Found on the current feed only

Package history

Version Size Last updated Downloads Mirrored?
1.4.2 28.93 KB Mon, 24 Feb 2025 12:44:23 GMT 5
1.2.0 9.66 KB Wed, 13 Jun 2018 16:44:41 GMT 56