Table of Contents

Class RelayDescription

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

Represents a relay description.

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

Constructors

RelayDescription(string, RelayType)

Initializes a new instance of the RelayDescription class.

public RelayDescription(string relayPath, RelayType type)

Parameters

relayPath string

The path of the relay.

type RelayType

The relay type.

Properties

Authorization

Gets the AuthorizationRules.

public AuthorizationRules Authorization { get; }

Property Value

AuthorizationRules

The AuthorizationRules.

CollectionName

Gets or sets the name of the collection associated with the relay.

public string CollectionName { get; }

Property Value

string

The name of the collection associated with the relay.

CreatedAt

Gets or sets the exact time the relay was created.

public DateTime CreatedAt { get; }

Property Value

DateTime

The exact time the relay was created.

IsDynamic

Gets or sets whether the relay is dynamic.

public bool IsDynamic { get; }

Property Value

bool

true if the relay is dynamic; otherwise, false.

ListenerCount

Gets or sets the number of listeners for this relay.

public int ListenerCount { get; }

Property Value

int

The number of listeners for this relay.

Path

Gets or sets the path of the relay.

public string Path { get; set; }

Property Value

string

The path of the relay.

RelayType

Gets or sets the relay type.

public RelayType RelayType { get; set; }

Property Value

RelayType

The relay type.

RequiresClientAuthorization

Gets or sets whether client authorization is needed for this relay.

public bool RequiresClientAuthorization { get; set; }

Property Value

bool

true if client authorization is needed for this relay; otherwise, false.

RequiresTransportSecurity

Gets or sets whether transport security is needed for this relay.

public bool RequiresTransportSecurity { get; set; }

Property Value

bool

true if transport security is needed for this relay; otherwise, false.

UpdatedAt

Gets or sets the date when the relay was updated.

public DateTime UpdatedAt { get; }

Property Value

DateTime

The date when the relay was updated.

UserMetadata

Gets or sets the user metadata associated with this instance.

public string UserMetadata { get; set; }

Property Value

string

The user metadata associated with this instance.