QueueClient.CreateFromConnectionString Method

Definition

Namespace:

Microsoft.ServiceBus.Messaging

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Overloads

CreateFromConnectionString(String)	Creates a new instance of QueueClient using the specified connection string.
CreateFromConnectionString(String, ReceiveMode)	Creates a new instance of QueueClient using the specified connection string and receiving mode.
CreateFromConnectionString(String, String)	Creates a new copy of QueueClient from a connection string with the specified queue path. Use this overload only when the connection string does not use the EntityPath property.
CreateFromConnectionString(String, String, ReceiveMode)	Creates a new instance of QueueClient from a connection string with the specified path and mode. Use this overload only when the connection string does not use the EntityPath property.

CreateFromConnectionString(String)

Creates a new instance of QueueClient using the specified connection string.

public static Microsoft.ServiceBus.Messaging.QueueClient CreateFromConnectionString (string connectionString);

static member CreateFromConnectionString : string -> Microsoft.ServiceBus.Messaging.QueueClient

Public Shared Function CreateFromConnectionString (connectionString As String) As QueueClient

Parameters

connectionString

String

The connection string to use.

Returns

QueueClient

The newly created QueueClient instance.

Exceptions

ArgumentException

Thrown when the format of the connectionString parameter is incorrect.

Remarks

This method expects the connection string supplied has entity level information such as the entity path and authentication information supplied.

CreateFromConnectionString(String, ReceiveMode)

Creates a new instance of QueueClient using the specified connection string and receiving mode.

public static Microsoft.ServiceBus.Messaging.QueueClient CreateFromConnectionString (string connectionString, Microsoft.ServiceBus.Messaging.ReceiveMode mode);

static member CreateFromConnectionString : string * Microsoft.ServiceBus.Messaging.ReceiveMode -> Microsoft.ServiceBus.Messaging.QueueClient

Public Shared Function CreateFromConnectionString (connectionString As String, mode As ReceiveMode) As QueueClient

Parameters

connectionString

String

The connection string to use.

mode

ReceiveMode

The ReceiveMode.

Returns

QueueClient

The newly created QueueClient instance.

Exceptions

ArgumentException

Thrown when the format of the connectionString parameter is incorrect.

Remarks

This method expects the connection string supplied has entity level information such as the entity path and authentication information supplied.

CreateFromConnectionString(String, String)

Creates a new copy of QueueClient from a connection string with the specified queue path. Use this overload only when the connection string does not use the EntityPath property.

public static Microsoft.ServiceBus.Messaging.QueueClient CreateFromConnectionString (string connectionString, string path);

static member CreateFromConnectionString : string * string -> Microsoft.ServiceBus.Messaging.QueueClient

Public Shared Function CreateFromConnectionString (connectionString As String, path As String) As QueueClient

Parameters

connectionString

String

The connection string used.

path

String

The path to the queue.

Returns

QueueClient

The created QueueClient.

Exceptions

ArgumentException

Thrown when the format of the connectionString parameter is incorrect.

Remarks

This method should only be used with a connection string that has namespace level authentication because the connection string supplied should not have entity level information associated with it.

CreateFromConnectionString(String, String, ReceiveMode)

Creates a new instance of QueueClient from a connection string with the specified path and mode. Use this overload only when the connection string does not use the EntityPath property.

public static Microsoft.ServiceBus.Messaging.QueueClient CreateFromConnectionString (string connectionString, string path, Microsoft.ServiceBus.Messaging.ReceiveMode mode);

static member CreateFromConnectionString : string * string * Microsoft.ServiceBus.Messaging.ReceiveMode -> Microsoft.ServiceBus.Messaging.QueueClient

Public Shared Function CreateFromConnectionString (connectionString As String, path As String, mode As ReceiveMode) As QueueClient

Parameters

connectionString

String

The connection string.

path

String

The path to the queue.

mode

ReceiveMode

The ReceiveMode.

Returns

QueueClient

The created QueueClient.

Exceptions

ArgumentException

Thrown when the format of the connectionString parameter is incorrect.

Remarks

This method should only be used with a connection string that has namespace level authentication because the connection string supplied should not have entity level information associated with it.