ServiceBusConnectionStringBuilder 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
type ServiceBusConnectionStringBuilder = class
Public Class ServiceBusConnectionStringBuilder
Inheritance
System.Object
ServiceBusConnectionStringBuilder

Constructors

ServiceBusConnectionStringBuilder()

Initializes a new instance of the ServiceBusConnectionStringBuilder class.

ServiceBusConnectionStringBuilder(String)

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

Properties

EnableAmqpLinkRedirect
Endpoints

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

EntityPath

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

ManagementPort

Gets or sets the TCP port number for management operations.

OAuthDomain

Gets or sets the authentication domain for the connection.

OAuthPassword

Gets or sets the authentication password for the connection.

OAuthUsername

Gets or sets the authentication user name for the connection.

OperationTimeout

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

Publisher

Get or sets the publisher identifier.

RuntimePort

Gets or sets the TCP port number for runtime operation.

SharedAccessKey

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

SharedAccessKeyName

Gets or sets the name of the shared access key.

SharedAccessSignature

Gets or sets the SAS access token.

SharedSecretIssuerName

Gets or sets the shared secret issuer name.

SharedSecretIssuerSecret

Gets or sets the shared secret issuer secret.

StsEndpoints

Gets a set of STS endpoints.

TransportType

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

WindowsCredentialDomain

Gets or sets the Windows credential domain.

WindowsCredentialPassword

Gets or sets the Windows credential password.

WindowsCredentialUsername

Gets or sets the Windows credential user name.

Methods

CreateUsingOAuthCredential(IEnumerable<Uri>, IEnumerable<Uri>, Int32, Int32, String, String, SecureString)

Creates a connection string using authentication credentials.

CreateUsingSharedAccessKey(IEnumerable<Uri>, Int32, Int32, String, String)

Create a connection string using the shared access key.

CreateUsingSharedAccessKey(Uri, String, String)

Create a connection string using the shared access key.

CreateUsingSharedAccessSignature(Uri, String, String, String)

Creates a connection string using SAS credentials.

CreateUsingSharedSecret(IEnumerable<Uri>, IEnumerable<Uri>, Int32, Int32, String, String)

Creates a connection string using the shared secret credentials.

CreateUsingSharedSecret(Uri, String, String)

Creates a connection string using the shared secret credentials.

CreateUsingWindowsCredential(IEnumerable<Uri>, IEnumerable<Uri>, Int32, Int32, String, String, SecureString)

Creates a connection string using Windows credentials.

GetAbsoluteManagementEndpoints()

Retrieves the absolute management endpoints.

GetAbsoluteRuntimeEndpoints()

Retrieves the absolute runtime endpoints.

ToString()

Returns a string that represents the current object.

Applies to