AzuriteInstance

Represents a running Azurite instance with process lifecycle management.

Definition

Assembly: CloudNimble.Breakdance.Azurite.dll

Namespace: CloudNimble.Breakdance.Azurite

Inheritance: System.Object

Syntax

CloudNimble.Breakdance.Azurite.AzuriteInstance

Summary

Represents a running Azurite instance with process lifecycle management.

Constructors

.ctor

Creates a new AzuriteInstance with the specified configuration.

Syntax

public AzuriteInstance(CloudNimble.Breakdance.Azurite.AzuriteConfiguration configuration = null)

Parameters

Name	Type	Description
configuration	CloudNimble.Breakdance.Azurite.AzuriteConfiguration	The configuration options.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

BlobEndpoint

Gets the HTTP endpoint URL for the Blob service. Returns null if Blob service was not requested or not started.

Syntax

public string BlobEndpoint { get; }

Property Value

Type: string

BlobPort

Gets the port number for the Blob service, or null if not started.

Syntax

public System.Nullable<int> BlobPort { get; private set; }

Property Value

Type: System.Nullable<int>

IsRunning

Gets whether the Azurite instance is currently running.

Syntax

public bool IsRunning { get; }

Property Value

Type: bool

QueueEndpoint

Gets the HTTP endpoint URL for the Queue service. Returns null if Queue service was not requested or not started.

Syntax

public string QueueEndpoint { get; }

Property Value

Type: string

QueuePort

Gets the port number for the Queue service, or null if not started.

Syntax

public System.Nullable<int> QueuePort { get; private set; }

Property Value

Type: System.Nullable<int>

StandardError

Gets the standard error captured from the Azurite process.

Syntax

public string StandardError { get; }

Property Value

Type: string

StandardOutput

Gets the standard output captured from the Azurite process.

Syntax

public string StandardOutput { get; }

Property Value

Type: string

TableEndpoint

Gets the HTTP endpoint URL for the Table service. Returns null if Table service was not requested or not started.

Syntax

public string TableEndpoint { get; }

Property Value

Type: string

TablePort

Gets the port number for the Table service, or null if not started.

Syntax

public System.Nullable<int> TablePort { get; private set; }

Property Value

Type: System.Nullable<int>

Methods

ClearAllBlobContainersAsync

Deletes all blob containers in the storage account.

Syntax

public System.Threading.Tasks.Task ClearAllBlobContainersAsync()

Returns

Type: System.Threading.Tasks.Task A task that completes when all containers are deleted.

ClearAllQueuesAsync

Deletes all queues in the storage account.

Syntax

public System.Threading.Tasks.Task ClearAllQueuesAsync()

Returns

Type: System.Threading.Tasks.Task A task that completes when all queues are deleted.

ClearAllTablesAsync

Deletes all tables in the storage account.

Syntax

public System.Threading.Tasks.Task ClearAllTablesAsync()

Returns

Type: System.Threading.Tasks.Task A task that completes when all tables are deleted.

ClearQueueMessagesAsync

Clears all messages from a queue. Does nothing if the queue doesn’t exist.

Syntax

public System.Threading.Tasks.Task ClearQueueMessagesAsync(string queueName)

Parameters

Name	Type	Description
queueName	string	The name of the queue to clear.

Returns

Type: System.Threading.Tasks.Task A task that completes when the operation finishes.

DeleteBlobContainerAsync

Deletes a blob container. Does nothing if the container doesn’t exist.

Syntax

public System.Threading.Tasks.Task DeleteBlobContainerAsync(string containerName)

Parameters

Name	Type	Description
containerName	string	The name of the container to delete.

Returns

Type: System.Threading.Tasks.Task A task that completes when the operation finishes.

DeleteQueueAsync

Deletes a queue. Does nothing if the queue doesn’t exist.

Syntax

public System.Threading.Tasks.Task DeleteQueueAsync(string queueName)

Parameters

Name	Type	Description
queueName	string	The name of the queue to delete.

Returns

Type: System.Threading.Tasks.Task A task that completes when the operation finishes.

DeleteTableAsync

Deletes a table. Does nothing if the table doesn’t exist.

Syntax

public System.Threading.Tasks.Task DeleteTableAsync(string tableName)

Parameters

Name	Type	Description
tableName	string	The name of the table to delete.

Returns

Type: System.Threading.Tasks.Task A task that completes when the operation finishes.

Dispose

Disposes the Azurite instance and releases all resources.

Syntax

public void Dispose()

DisposeAsync

Asynchronously disposes the Azurite instance and releases all resources.

Syntax

public System.Threading.Tasks.ValueTask DisposeAsync()

Returns

Type: System.Threading.Tasks.ValueTask

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
obj	object?	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

GetConnectionString

Gets a connection string for the Development Storage account. Only includes endpoints for services that were requested.

Syntax

public string GetConnectionString(string accountName = "devstoreaccount1", string accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==")

Parameters

Name	Type	Description
accountName	string	The account name. Defaults to “devstoreaccount1”.
accountKey	string	The account key. Defaults to the well-known development key.

Returns

Type: string A connection string that can be used with Azure Storage SDKs.

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

ListBlobContainersAsync

Lists all blob containers in the storage account.

Syntax

public System.Threading.Tasks.Task<System.Collections.Generic.List<string>> ListBlobContainersAsync()

Returns

Type: System.Threading.Tasks.Task<System.Collections.Generic.List<string>> A list of container names.

ListQueuesAsync

Lists all queues in the storage account.

Syntax

public System.Threading.Tasks.Task<System.Collections.Generic.List<string>> ListQueuesAsync()

Returns

Type: System.Threading.Tasks.Task<System.Collections.Generic.List<string>> A list of queue names.

ListTablesAsync

Lists all tables in the storage account.

Syntax

public System.Threading.Tasks.Task<System.Collections.Generic.List<string>> ListTablesAsync()

Returns

Type: System.Threading.Tasks.Task<System.Collections.Generic.List<string>> A list of table names.

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

StartAsync

Starts the Azurite instance asynchronously. Includes automatic retry logic for port conflicts when AzuriteConfiguration.AutoAssignPorts is true.

Syntax

public System.Threading.Tasks.Task StartAsync()

Returns

Type: System.Threading.Tasks.Task A task that completes when Azurite is ready to accept connections.

StopAsync

Stops the Azurite instance asynchronously.

Syntax

public System.Threading.Tasks.Task StopAsync()

Returns

Type: System.Threading.Tasks.Task A task that completes when Azurite has stopped.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

Related APIs

• System.IDisposable
• System.IAsyncDisposable