ServiceBusConnectionStringBuilder Class

 

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.

Namespace:   Microsoft.ServiceBus
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)

System.Object
  Microsoft.ServiceBus.ServiceBusConnectionStringBuilder

public class ServiceBusConnectionStringBuilder

NameDescription
System_CAPS_pubmethodServiceBusConnectionStringBuilder()

Initializes a new instance of the ServiceBusConnectionStringBuilder class.

System_CAPS_pubmethodServiceBusConnectionStringBuilder(String)

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

NameDescription
System_CAPS_pubpropertyEnableAmqpLinkRedirect

System_CAPS_pubpropertyEndpoints

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

System_CAPS_pubpropertyEntityPath

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

System_CAPS_pubpropertyManagementPort

Gets or sets the TCP port number for management operations.

System_CAPS_pubpropertyOAuthDomain

Gets or sets the authentication domain for the connection.

System_CAPS_pubpropertyOAuthPassword

Gets or sets the authentication password for the connection.

System_CAPS_pubpropertyOAuthUsername

Gets or sets the authentication user name for the connection.

System_CAPS_pubpropertyOperationTimeout

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

System_CAPS_pubpropertyPublisher

Get or sets the publisher identifier.

System_CAPS_pubpropertyRuntimePort

Gets or sets the TCP port number for runtime operation.

System_CAPS_pubpropertySharedAccessKey

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

System_CAPS_pubpropertySharedAccessKeyName

Gets or sets the name of the shared access key.

System_CAPS_pubpropertySharedAccessSignature

Gets or sets the SAS access token.

System_CAPS_pubpropertySharedSecretIssuerName

Gets or sets the shared secret issuer name.

System_CAPS_pubpropertySharedSecretIssuerSecret

Gets or sets the shared secret issuer secret.

System_CAPS_pubpropertyStsEndpoints

Gets a set of STS endpoints.

System_CAPS_pubpropertyTransportType

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

System_CAPS_pubpropertyWindowsCredentialDomain

Gets or sets the Windows credential domain.

System_CAPS_pubpropertyWindowsCredentialPassword

Gets or sets the Windows credential password.

System_CAPS_pubpropertyWindowsCredentialUsername

Gets or sets the Windows credential user name.

NameDescription
System_CAPS_pubmethodSystem_CAPS_staticCreateUsingOAuthCredential(IEnumerable<Uri>, IEnumerable<Uri>, Int32, Int32, String, String, SecureString)

Creates a connection string using authentication credentials.

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

Create a connection string using the shared access key.

System_CAPS_pubmethodSystem_CAPS_staticCreateUsingSharedAccessKey(Uri, String, String)

Create a connection string using the shared access key.

System_CAPS_pubmethodSystem_CAPS_staticCreateUsingSharedAccessSignature(Uri, String, String, String)

Creates a connection string using SAS credentials.

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

Creates a connection string using the shared secret credentials.

System_CAPS_pubmethodSystem_CAPS_staticCreateUsingSharedSecret(Uri, String, String)

Creates a connection string using the shared secret credentials.

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

Creates a connection string using Windows credentials.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetAbsoluteManagementEndpoints()

Retrieves the absolute management endpoints.

System_CAPS_pubmethodGetAbsoluteRuntimeEndpoints()

Retrieves the absolute runtime endpoints.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Overrides Object.ToString().)

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: