RelayDescription RelayDescription Class

Represents a relay description.

Syntax

Declaration

[DataContract(Name = "RelayDescription", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public class RelayDescription : EntityDescription, IExtensibleDataObject, IResourceDescription<DataContract(Name:="RelayDescription", Namespace:="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>
Public Class RelayDescription
    Inherits EntityDescription
    Implements IExtensibleDataObject, IResourceDescription

Inheritance Hierarchy

Constructors summary

Initializes a new instance of the RelayDescription class.

Properties summary

Gets the AuthorizationRules.

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

Gets or sets the exact time the relay was created.

Gets or sets whether the relay is dynamic.

Gets or sets the number of listeners for this relay.

Gets or sets the path of the relay.

Gets or sets the relay type.

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

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

Gets or sets the date when the relay was updated.

Gets or sets the user metadata associated with this instance.

Constructors

  • RelayDescription(String, RelayType)
    RelayDescription(String, RelayType)

    Initializes a new instance of the RelayDescription class.

    public RelayDescription(string relayPath, RelayType type)Public Sub New(relayPath As String, type As RelayType)

    Parameters

Properties

  • Authorization
    Authorization

    Gets the AuthorizationRules.

    public AuthorizationRules Authorization { get; }Public ReadOnly Property Authorization As AuthorizationRules

    Property Value

  • CollectionName
    CollectionName

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

    public string CollectionName { get; }Public ReadOnly Property CollectionName As String

    Property Value

    • The name of the collection associated with the relay.

  • CreatedAt
    CreatedAt

    Gets or sets the exact time the relay was created.

    public DateTime CreatedAt { get; }Public ReadOnly Property CreatedAt As Date

    Property Value

  • IsDynamic
    IsDynamic

    Gets or sets whether the relay is dynamic.

    public bool IsDynamic { get; }Public ReadOnly Property IsDynamic As Boolean

    Property Value

  • ListenerCount
    ListenerCount

    Gets or sets the number of listeners for this relay.

    public int ListenerCount { get; }Public ReadOnly Property ListenerCount As Integer

    Property Value

    • The number of listeners for this relay.

  • Path
    Path

    Gets or sets the path of the relay.

    public string Path { get; set; }Public Property Path As String

    Property Value

  • RelayType
    RelayType

    Gets or sets the relay type.

    public RelayType RelayType { get; set; }Public Property RelayType As RelayType

    Property Value

  • RequiresClientAuthorization
    RequiresClientAuthorization

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

    public bool RequiresClientAuthorization { get; set; }Public Property RequiresClientAuthorization As Boolean

    Property Value

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

  • RequiresTransportSecurity
    RequiresTransportSecurity

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

    public bool RequiresTransportSecurity { get; set; }Public Property RequiresTransportSecurity As Boolean

    Property Value

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

  • UpdatedAt
    UpdatedAt

    Gets or sets the date when the relay was updated.

    public DateTime UpdatedAt { get; }Public ReadOnly Property UpdatedAt As Date

    Property Value

  • UserMetadata
    UserMetadata

    Gets or sets the user metadata associated with this instance.

    public string UserMetadata { get; set; }Public Property UserMetadata As String

    Property Value

    • The user metadata associated with this instance.

Details

Assembly

Microsoft.ServiceBus.dll