AzureQueueOptions Class

Definition

Namespace

Savvyio.Extensions.QueueStorage

Assemblies

Savvyio.Extensions.QueueStorage.dll

Source

src/Savvyio.Extensions.QueueStorage/AzureQueueOptions.cs

Configuration options for AzureQueue<TRequest>.

public class AzureQueueOptions : IValidatableParameterObject, IParameterObject

Inheritance

object

AzureQueueOptions

Implements

IValidatableParameterObject

IParameterObject

Derived

AzureQueueOptions<TMarker>

Examples

Configure an AzureQueueOptions with the Azure Storage account name and queue name required for Azure Queue Storage integration.

using Savvyio.Extensions.QueueStorage;

namespace ExampleApp;

public class AzureQueueSetup
{
    public static AzureQueueOptions CreateConnectionStringOptions()
    {
        var options = new AzureQueueOptions
        {
            ConnectionString = "UseDevelopmentStorage=true",
            QueueName = "account-commands"
        };
        return options;
    }

    public static AzureQueueOptions CreateAccountOptions()
    {
        var options = new AzureQueueOptions
        {
            StorageAccountName = "mystorageaccount",
            QueueName = "account-commands"
        };
        return options;
    }
}

Constructors

Name	Description
AzureQueueOptions()	Initializes a new instance of the AzureQueueOptions class.

Fields

Name	Description
MaxNumberOfMessages	The maximum number of messages that Azure Queue Storage supports when retrieving.
MaxVisibilityTimeout	The maximum visibility timeout for messages in Azure Queue Storage.

Properties

Name	Description
ConnectionString	Gets or sets the connection string used to connect to the Azure storage account.
Credential	Gets or sets the credential used to authenticate with Azure.
QueueName	Gets or sets the name of the queue.
ReceiveContext	Gets the options for receiving messages from the queue.
SasCredential	Gets or sets the SAS credential used to authenticate with Azure.
SendContext	Gets the options for sending messages to the queue.
Settings	Gets the settings for the QueueClient>.
StorageAccountName	Gets or sets the name of the storage account.
StorageKeyCredential	Gets or sets the storage key credential used to authenticate with Azure.

Methods

Name	Description
PostConfigureClient(Action<QueueClient>)	Provides a way to post-configure the client after it has been created.
ValidateOptions()	Validates the options to ensure they are in a valid state.