Table of Contents

Class EventHubDescription

Namespace
Microsoft.ServiceBus.Messaging
Assembly
Microsoft.ServiceBus.dll

Represents the metadata description of an Event Hub.

[DataContract(Name = "EventHubDescription", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public sealed class EventHubDescription : EntityDescription, IExtensibleDataObject
Inheritance
EventHubDescription
Implements
IExtensibleDataObject
Inherited Members

Constructors

EventHubDescription(string)

Initializes a new instance of the EventHubDescription class.

public EventHubDescription(string path)

Parameters

path string

The path of the event hub relative to the service namespace base address.

Properties

Authorization

Gets the AuthorizationRules.

public AuthorizationRules Authorization { get; }

Property Value

AuthorizationRules

The AuthorizationRules.

CreatedAt

Gets the exact time the message was created.

public DateTime CreatedAt { get; }

Property Value

DateTime

The exact time the message was created.

MessageRetentionInDays

Gets or sets the number of days to retain the events for this Event Hub.

public long MessageRetentionInDays { get; set; }

Property Value

long

The retention time of the event data, in days.

PartitionCount

Gets or sets the current number of shards on the Event Hub.

public int PartitionCount { get; set; }

Property Value

int

Returns the number of subscriptions on the Event Hub.

Exceptions

ArgumentOutOfRangeException

Thrown if the partition count value is negative.

PartitionIds

Gets identifiers for partitions created for Event Hubs.

public string[] PartitionIds { get; }

Property Value

string[]

Returns string.

Path

Gets the full path of the Event Hub.

public string Path { get; set; }

Property Value

string

The path of the Event Hub.

Exceptions

InvalidOperationException

Thrown if an attempt is made to set the value of this property when the instance is marked as readonly.

Status

Gets or sets the current status of the Event Hub (enabled or disabled).

public EntityStatus Status { get; set; }

Property Value

EntityStatus

The current status of the event hub.

UpdatedAt

Gets the exact time the message has been updated.

public DateTime UpdatedAt { get; }

Property Value

DateTime

The time the message has been updated.

UserMetadata

Gets or sets the user metadata.

public string UserMetadata { get; set; }

Property Value

string

The user metadata.