Service​Bus​Connection​String​Builder Class

Definition

Creates and manages the contents of connection strings. You can use this class to construct a connection string for creating client messaging entities. It can also be used to perform basic validation on an existing connection string.

public class ServiceBusConnectionStringBuilder
Inheritance
ServiceBusConnectionStringBuilder

Constructors

Service​Bus​Connection​String​Builder()

Initializes a new instance of the ServiceBusConnectionStringBuilder class.

Service​Bus​Connection​String​Builder(​String)

Initializes a new instance of the ServiceBusConnectionStringBuilder class with a specified existing connection string.

Properties

Enable​Amqp​Link​Redirect
Endpoints

Gets a collection of service endpoints. Each endpoint must reference the same Service Bus namespace.

Entity​Path

Gets or sets the entity path for the Path, Path, and Path properties.

Management​Port

Gets or sets the TCP port number for management operations.

O​Auth​Domain

Gets or sets the authentication domain for the connection.

O​Auth​Password

Gets or sets the authentication password for the connection.

O​Auth​Username

Gets or sets the authentication user name for the connection.

Operation​Timeout

Gets or sets the TimeSpan that specifies how long the messaging operation has to complete before timing out.

Publisher

Get or sets the publisher identifier.

Runtime​Port

Gets or sets the TCP port number for runtime operation.

Shared​Access​Key

Gets or sets the shared access key for the connection authentication.

Shared​Access​Key​Name

Gets or sets the name of the shared access key.

Shared​Access​Signature

Gets or sets the SAS access token.

Shared​Secret​Issuer​Name

Gets or sets the shared secret issuer name.

Shared​Secret​Issuer​Secret

Gets or sets the shared secret issuer secret.

Sts​Endpoints

Gets a set of STS endpoints.

Transport​Type

Gets or sets the transport type to be used for client messaging entities.

Windows​Credential​Domain

Gets or sets the Windows credential domain.

Windows​Credential​Password

Gets or sets the Windows credential password.

Windows​Credential​Username

Gets or sets the Windows credential user name.

Methods

Create​Using​OAuth​Credential(​IEnumerable<​Uri>, ​IEnumerable<​Uri>, ​Int32, ​Int32, ​String, ​String, ​Secure​String)

Creates a connection string using authentication credentials.

Create​Using​Shared​Access​Key(​Uri, ​String, ​String)

Create a connection string using the shared access key.

Create​Using​Shared​Access​Key(​IEnumerable<​Uri>, ​Int32, ​Int32, ​String, ​String)

Create a connection string using the shared access key.

Create​Using​Shared​Access​Signature(​Uri, ​String, ​String, ​String)

Creates a connection string using SAS credentials.

Create​Using​Shared​Secret(​Uri, ​String, ​String)

Creates a connection string using the shared secret credentials.

Create​Using​Shared​Secret(​IEnumerable<​Uri>, ​IEnumerable<​Uri>, ​Int32, ​Int32, ​String, ​String)

Creates a connection string using the shared secret credentials.

Create​Using​Windows​Credential(​IEnumerable<​Uri>, ​IEnumerable<​Uri>, ​Int32, ​Int32, ​String, ​String, ​Secure​String)

Creates a connection string using Windows credentials.

Get​Absolute​Management​Endpoints()

Retrieves the absolute management endpoints.

Get​Absolute​Runtime​Endpoints()

Retrieves the absolute runtime endpoints.

To​String()

Returns a string that represents the current object.

Extension Methods

IsDefined(Object)
IsNull(Object)
IsPrimitive(Object)