QueueClient.Create QueueClient.Create QueueClient.Create Method

Definition

Overloads

Create(String) Create(String) Create(String)

Creates a new copy of QueueClient with specified path.

Create(String, ReceiveMode) Create(String, ReceiveMode) Create(String, ReceiveMode)

Creates a new copy of QueueClient with specified path and mode.

Create(Uri, String, AuthenticationContext, ClientAssertionCertificate, ReceiveMode, Nullable<TimeSpan>, TransportType) Create(Uri, String, AuthenticationContext, ClientAssertionCertificate, ReceiveMode, Nullable<TimeSpan>, TransportType)

Creates a new instance of the QueueClient by using Azure Active Directory authentication context.

Create(Uri, String, AuthenticationContext, ClientCredential, ReceiveMode, Nullable<TimeSpan>, TransportType) Create(Uri, String, AuthenticationContext, ClientCredential, ReceiveMode, Nullable<TimeSpan>, TransportType)

Creates a new instance of the QueueClient by using Azure Active Directory authentication context.

Create(Uri, String, AuthenticationContext, String, UserPasswordCredential, ReceiveMode, Nullable<TimeSpan>, TransportType) Create(Uri, String, AuthenticationContext, String, UserPasswordCredential, ReceiveMode, Nullable<TimeSpan>, TransportType)

Creates a new instance of the QueueClient by using Azure Active Directory authentication context.

Create(Uri, String, AuthenticationContext, String, Uri, IPlatformParameters, UserIdentifier, ReceiveMode, Nullable<TimeSpan>, TransportType) Create(Uri, String, AuthenticationContext, String, Uri, IPlatformParameters, UserIdentifier, ReceiveMode, Nullable<TimeSpan>, TransportType)

Creates a new instance of the QueueClient by using Azure Active Directory authentication context.

Create(String) Create(String) Create(String)

Creates a new copy of QueueClient with specified path.

public static Microsoft.ServiceBus.Messaging.QueueClient Create (string path);
static member Create : string -> Microsoft.ServiceBus.Messaging.QueueClient
Public Shared Function Create (path As String) As QueueClient
Parameters
path
String String String

The path.

Returns

Remarks

This method will attempt to retrieve the connection string information from either app.config, or web.config files. User must supply the connection string using the "AppSettings" section of the configuration. The format of the section is as follows:

        <pre><code><appSettings><!-- Service Bus specific app setings for messaging connections --><add key="Microsoft.ServiceBus.ConnectionString" value="Endpoint=sb://[your namespace].servicebus.windows.net;SharedSecretIssuer=owner;SharedSecretValue=[your secret]"></add></appSettings></code></pre>

Create(String, ReceiveMode) Create(String, ReceiveMode) Create(String, ReceiveMode)

Creates a new copy of QueueClient with specified path and mode.

public static Microsoft.ServiceBus.Messaging.QueueClient Create (string path, Microsoft.ServiceBus.Messaging.ReceiveMode mode);
static member Create : string * Microsoft.ServiceBus.Messaging.ReceiveMode -> Microsoft.ServiceBus.Messaging.QueueClient
Public Shared Function Create (path As String, mode As ReceiveMode) As QueueClient
Parameters
path
String String String

The path.

Returns

Remarks

This method will attempt to retrieve the connection string information from either app.config, or web.config files. User must supply the connection string using the "AppSettings" section of the configuration. The format of the section is as follows:

        <pre><code><appSettings><!-- Service Bus specific app setings for messaging connections --><add key="Microsoft.ServiceBus.ConnectionString" value="Endpoint=sb://[your namespace].servicebus.windows.net;SharedSecretIssuer=owner;SharedSecretValue=[your secret]"></add></appSettings></code></pre>

Create(Uri, String, AuthenticationContext, ClientAssertionCertificate, ReceiveMode, Nullable<TimeSpan>, TransportType) Create(Uri, String, AuthenticationContext, ClientAssertionCertificate, ReceiveMode, Nullable<TimeSpan>, TransportType)

Creates a new instance of the QueueClient by using Azure Active Directory authentication context.

public static Microsoft.ServiceBus.Messaging.QueueClient Create (Uri endpointAddress, string path, Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext authContext, Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertionCertificate clientAssertionCertificate, Microsoft.ServiceBus.Messaging.ReceiveMode mode = Microsoft.ServiceBus.Messaging.ReceiveMode.PeekLock, Nullable<TimeSpan> operationTimeout = null, Microsoft.ServiceBus.Messaging.TransportType transportType = Microsoft.ServiceBus.Messaging.TransportType.NetMessaging);
static member Create : Uri * string * Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext * Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertionCertificate * Microsoft.ServiceBus.Messaging.ReceiveMode * Nullable<TimeSpan> * Microsoft.ServiceBus.Messaging.TransportType -> Microsoft.ServiceBus.Messaging.QueueClient
Parameters
endpointAddress
Uri Uri Uri

Fully qualified domain name for Sercvice Bus. Most likely, {yournamespace}.servicebus.windows.net

path
String String String

The path to the queue.

authContext
AuthenticationContext AuthenticationContext AuthenticationContext

AuthenticationContext for AAD.

clientAssertionCertificate
ClientAssertionCertificate ClientAssertionCertificate ClientAssertionCertificate

The client assertion certificate credential.

mode
ReceiveMode ReceiveMode ReceiveMode

The receive mode.

operationTimeout
Nullable<TimeSpan>

TimeSpan that specifies how long the messaging operation has to complete before timing out

transportType
TransportType TransportType TransportType

Messaging transport type.

Returns

Create(Uri, String, AuthenticationContext, ClientCredential, ReceiveMode, Nullable<TimeSpan>, TransportType) Create(Uri, String, AuthenticationContext, ClientCredential, ReceiveMode, Nullable<TimeSpan>, TransportType)

Creates a new instance of the QueueClient by using Azure Active Directory authentication context.

public static Microsoft.ServiceBus.Messaging.QueueClient Create (Uri endpointAddress, string path, Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext authContext, Microsoft.IdentityModel.Clients.ActiveDirectory.ClientCredential clientCredential, Microsoft.ServiceBus.Messaging.ReceiveMode mode = Microsoft.ServiceBus.Messaging.ReceiveMode.PeekLock, Nullable<TimeSpan> operationTimeout = null, Microsoft.ServiceBus.Messaging.TransportType transportType = Microsoft.ServiceBus.Messaging.TransportType.NetMessaging);
static member Create : Uri * string * Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext * Microsoft.IdentityModel.Clients.ActiveDirectory.ClientCredential * Microsoft.ServiceBus.Messaging.ReceiveMode * Nullable<TimeSpan> * Microsoft.ServiceBus.Messaging.TransportType -> Microsoft.ServiceBus.Messaging.QueueClient
Parameters
endpointAddress
Uri Uri Uri

Fully qualified domain name for Service Bus. Most likely, {yournamespace}.servicebus.windows.net

path
String String String

The path to the queue.

authContext
AuthenticationContext AuthenticationContext AuthenticationContext

AuthenticationContext for AAD.

clientCredential
ClientCredential ClientCredential ClientCredential

The app credential.

mode
ReceiveMode ReceiveMode ReceiveMode

The receive mode.

operationTimeout
Nullable<TimeSpan>

TimeSpan that specifies how long the messaging operation has to complete before timing out

transportType
TransportType TransportType TransportType

Messaging transport type.

Returns

Create(Uri, String, AuthenticationContext, String, UserPasswordCredential, ReceiveMode, Nullable<TimeSpan>, TransportType) Create(Uri, String, AuthenticationContext, String, UserPasswordCredential, ReceiveMode, Nullable<TimeSpan>, TransportType)

Creates a new instance of the QueueClient by using Azure Active Directory authentication context.

public static Microsoft.ServiceBus.Messaging.QueueClient Create (Uri endpointAddress, string path, Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext authContext, string clientId, Microsoft.IdentityModel.Clients.ActiveDirectory.UserPasswordCredential userPasswordCredential, Microsoft.ServiceBus.Messaging.ReceiveMode mode = Microsoft.ServiceBus.Messaging.ReceiveMode.PeekLock, Nullable<TimeSpan> operationTimeout = null, Microsoft.ServiceBus.Messaging.TransportType transportType = Microsoft.ServiceBus.Messaging.TransportType.NetMessaging);
static member Create : Uri * string * Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext * string * Microsoft.IdentityModel.Clients.ActiveDirectory.UserPasswordCredential * Microsoft.ServiceBus.Messaging.ReceiveMode * Nullable<TimeSpan> * Microsoft.ServiceBus.Messaging.TransportType -> Microsoft.ServiceBus.Messaging.QueueClient
Parameters
endpointAddress
Uri Uri Uri

Fully qualified domain name for Service Bus. Most likely, {yournamespace}.servicebus.windows.net

path
String String String

The path to the queue.

authContext
AuthenticationContext AuthenticationContext AuthenticationContext

AuthenticationContext for AAD.

clientId
String String String

ClientId for AAD.

userPasswordCredential
UserPasswordCredential UserPasswordCredential UserPasswordCredential

The user password credential.

mode
ReceiveMode ReceiveMode ReceiveMode

The receive mode.

operationTimeout
Nullable<TimeSpan>

TimeSpan that specifies how long the messaging operation has to complete before timing out

transportType
TransportType TransportType TransportType

Messaging transport type.

Returns

Create(Uri, String, AuthenticationContext, String, Uri, IPlatformParameters, UserIdentifier, ReceiveMode, Nullable<TimeSpan>, TransportType) Create(Uri, String, AuthenticationContext, String, Uri, IPlatformParameters, UserIdentifier, ReceiveMode, Nullable<TimeSpan>, TransportType)

Creates a new instance of the QueueClient by using Azure Active Directory authentication context.

public static Microsoft.ServiceBus.Messaging.QueueClient Create (Uri endpointAddress, string path, Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext authContext, string clientId, Uri redirectUri, Microsoft.IdentityModel.Clients.ActiveDirectory.IPlatformParameters platformParameters, Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier userIdentifier = null, Microsoft.ServiceBus.Messaging.ReceiveMode mode = Microsoft.ServiceBus.Messaging.ReceiveMode.PeekLock, Nullable<TimeSpan> operationTimeout = null, Microsoft.ServiceBus.Messaging.TransportType transportType = Microsoft.ServiceBus.Messaging.TransportType.NetMessaging);
static member Create : Uri * string * Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext * string * Uri * Microsoft.IdentityModel.Clients.ActiveDirectory.IPlatformParameters * Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier * Microsoft.ServiceBus.Messaging.ReceiveMode * Nullable<TimeSpan> * Microsoft.ServiceBus.Messaging.TransportType -> Microsoft.ServiceBus.Messaging.QueueClient
Parameters
endpointAddress
Uri Uri Uri

Fully qualified domain name for Service Bus. Most likely, {yournamespace}.servicebus.windows.net

path
String String String

The path to the queue.

authContext
AuthenticationContext AuthenticationContext AuthenticationContext

AuthenticationContext for AAD.

clientId
String String String

ClientId for AAD.

redirectUri
Uri Uri Uri

The redrectUri on Client App.

platformParameters
IPlatformParameters IPlatformParameters IPlatformParameters

Platform parameters

userIdentifier
UserIdentifier UserIdentifier UserIdentifier

User Identifier

mode
ReceiveMode ReceiveMode ReceiveMode

The receive mode.

operationTimeout
Nullable<TimeSpan>

TimeSpan that specifies how long the messaging operation has to complete before timing out

transportType
TransportType TransportType TransportType

Messaging transport type.

Returns

Applies to