AzuriteConfiguration

Configuration options for an Azurite instance.

Definition

Assembly: CloudNimble.Breakdance.Azurite.dll

Namespace: CloudNimble.Breakdance.Azurite

Inheritance: System.Object

Syntax

CloudNimble.Breakdance.Azurite.AzuriteConfiguration

Summary

Configuration options for an Azurite instance.

Constructors

.ctor

Syntax

public AzuriteConfiguration()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

AutoAssignPorts

Gets or sets whether to automatically assign random ports when ports are not specified. When true and ports are null, random ports in 20000-30000 range will be assigned. Defaults to true.

Syntax

public bool AutoAssignPorts { get; set; }

Property Value

Type: bool

BlobPort

Gets or sets the optional blob service port. If null, Azurite will use its default port and we’ll parse the actual port from output.

Syntax

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

Property Value

Type: System.Nullable<int>

DebugLogPath

Gets or sets the debug log file path. Null means no debug logging.

Syntax

public string DebugLogPath { get; set; }

Property Value

Type: string

DisableTelemetry

Gets or sets whether to disable telemetry. Defaults to true.

Syntax

public bool DisableTelemetry { get; set; }

Property Value

Type: bool

ExtentMemoryLimitMB

Gets or sets the maximum memory limit in MB for in-memory storage. Null means unlimited. Only applies when AzuriteConfiguration.InMemoryPersistence is true.

Syntax

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

Property Value

Type: System.Nullable<int>

InMemoryPersistence

Gets or sets whether to use in-memory persistence (no disk storage). Defaults to true.

Syntax

public bool InMemoryPersistence { get; set; }

Property Value

Type: bool

InstanceName

Gets or sets a name to identify this Azurite instance (e.g., test class name). Used for process identification and debugging. The full window title will be “Breakdance.Azurite - ”. If not set, defaults to “Unknown”.

Syntax

public string InstanceName { get; set; }

Property Value

Type: string

Location

Gets or sets the workspace location for disk persistence. Only used when AzuriteConfiguration.InMemoryPersistence is false.

Syntax

public string Location { get; set; }

Property Value

Type: string

LooseMode

Gets or sets whether to enable loose mode (ignore unsupported headers/parameters). Defaults to false.

Syntax

public bool LooseMode { get; set; }

Property Value

Type: bool

MaxRetries

Gets or sets the maximum number of retry attempts when port conflicts occur. Only applies when AzuriteConfiguration.AutoAssignPorts is true. Defaults to 20.

Syntax

public int MaxRetries { get; set; }

Property Value

Type: int

QueuePort

Gets or sets the optional queue service port. If null, Azurite will use its default port and we’ll parse the actual port from output.

Syntax

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

Property Value

Type: System.Nullable<int>

Services

Gets or sets which services to start. Defaults to AzuriteServiceType.All.

Syntax

public CloudNimble.Breakdance.Azurite.AzuriteServiceType Services { get; set; }

Property Value

Type: CloudNimble.Breakdance.Azurite.AzuriteServiceType

Silent

Gets or sets whether to run in silent mode (no access logs). Defaults to true.

Syntax

public bool Silent { get; set; }

Property Value

Type: bool

SkipApiVersionCheck

Gets or sets whether to skip API version checking. Defaults to true.

Syntax

public bool SkipApiVersionCheck { get; set; }

Property Value

Type: bool

StartupTimeoutSeconds

Gets or sets the timeout in seconds to wait for Azurite to start. Defaults to 30 seconds.

Syntax

public int StartupTimeoutSeconds { get; set; }

Property Value

Type: int

TablePort

Gets or sets the optional table service port. If null, Azurite will use its default port and we’ll parse the actual port from output.

Syntax

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

Property Value

Type: System.Nullable<int>

Methods

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

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

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

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?