Class ServiceBusConnectionStringProperties | Azure SDK for .NET

The set of properties that comprise a Service Bus connection string.

Inheritance

System.Object

ServiceBusConnectionStringProperties

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Messaging.ServiceBus.dll

Syntax

public class ServiceBusConnectionStringProperties

Constructors

ServiceBusConnectionStringProperties()

Declaration

public ServiceBusConnectionStringProperties ();

Properties

Endpoint

The endpoint to be used for connecting to the Service Bus namespace.

Declaration

public Uri Endpoint { get; }

Property Value

System.Uri The endpoint address, including protocol, from the connection string.

EntityPath

The name of the specific Service Bus entity instance under the associated Service Bus namespace.

Declaration

public string EntityPath { get; }

Property Value

System.String

FullyQualifiedNamespace

The fully qualified Service Bus namespace that the consumer is associated with. This is likely to be similar to {yournamespace}.servicebus.windows.net.

Declaration

public string FullyQualifiedNamespace { get; }

Property Value

System.String The namespace of the Service Bus, as derived from the endpoint address of the connection string.

SharedAccessKey

The value of the shared access key, either for the Service Bus namespace or the Service Bus entity.

Declaration

public string SharedAccessKey { get; }

Property Value

System.String

SharedAccessKeyName

The name of the shared access key, either for the Service Bus namespace or the Service Bus entity.

Declaration

public string SharedAccessKeyName { get; }

Property Value

System.String

SharedAccessSignature

The value of the fully-formed shared access signature, either for the Service Bus namespace or the Service Bus entity.

Declaration

public string SharedAccessSignature { get; }

Property Value

System.String

Methods

Equals(Object)

Determines whether the specified System.Object is equal to this instance.

Declaration

[System.ComponentModel.EditorBrowsable]
public override bool Equals (object obj);

Parameters

System.Object obj The System.Object to compare with this instance.

Returns

System.Boolean true if the specified System.Object is equal to this instance; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

Declaration

[System.ComponentModel.EditorBrowsable]
public override int GetHashCode ();

Returns

System.Int32 A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Parse(String)

Parses the specified Service Bus connection string into its component properties.

Declaration

public static Azure.Messaging.ServiceBus.ServiceBusConnectionStringProperties Parse (string connectionString);

Parameters

System.String connectionString The connection string to parse.

Returns

Exceptions

System.FormatException The specified connection string was malformed and could not be parsed.

ToString()

Converts the instance to string representation.

Declaration

[System.ComponentModel.EditorBrowsable]
public override string ToString ();

Returns

System.String A System.String that represents this instance.