QueueClient Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| QueueClient(ServiceBusConnectionStringBuilder, ReceiveMode, RetryPolicy) |
Instantiates a new QueueClient to perform operations on a queue. |
| QueueClient(ServiceBusConnection, String, ReceiveMode, RetryPolicy) |
Creates a new instance of the Queue client on a given ServiceBusConnection |
| QueueClient(String, String, ReceiveMode, RetryPolicy) |
Instantiates a new QueueClient to perform operations on a queue. |
| QueueClient(String, String, ITokenProvider, TransportType, ReceiveMode, RetryPolicy) |
Creates a new instance of the Queue client using the specified endpoint, entity path, and token provider. |
QueueClient(ServiceBusConnectionStringBuilder, ReceiveMode, RetryPolicy)
- Source:
- QueueClient.cs
Instantiates a new QueueClient to perform operations on a queue.
public QueueClient (Microsoft.Azure.ServiceBus.ServiceBusConnectionStringBuilder connectionStringBuilder, Microsoft.Azure.ServiceBus.ReceiveMode receiveMode = Microsoft.Azure.ServiceBus.ReceiveMode.PeekLock, Microsoft.Azure.ServiceBus.RetryPolicy retryPolicy = default);new Microsoft.Azure.ServiceBus.QueueClient : Microsoft.Azure.ServiceBus.ServiceBusConnectionStringBuilder * Microsoft.Azure.ServiceBus.ReceiveMode * Microsoft.Azure.ServiceBus.RetryPolicy -> Microsoft.Azure.ServiceBus.QueueClientPublic Sub New (connectionStringBuilder As ServiceBusConnectionStringBuilder, Optional receiveMode As ReceiveMode = Microsoft.Azure.ServiceBus.ReceiveMode.PeekLock, Optional retryPolicy As RetryPolicy = Nothing)Parameters
- connectionStringBuilder
- ServiceBusConnectionStringBuilder
ServiceBusConnectionStringBuilder having namespace and queue information.
- receiveMode
- ReceiveMode
Mode of receive of messages. Defaults to ReceiveMode.PeekLock.
- retryPolicy
- RetryPolicy
Retry policy for queue operations. Defaults to Default
Remarks
Creates a new connection to the queue, which is opened during the first send/receive operation.
Applies to
QueueClient(ServiceBusConnection, String, ReceiveMode, RetryPolicy)
- Source:
- QueueClient.cs
Creates a new instance of the Queue client on a given ServiceBusConnection
public QueueClient (Microsoft.Azure.ServiceBus.ServiceBusConnection serviceBusConnection, string entityPath, Microsoft.Azure.ServiceBus.ReceiveMode receiveMode, Microsoft.Azure.ServiceBus.RetryPolicy retryPolicy);new Microsoft.Azure.ServiceBus.QueueClient : Microsoft.Azure.ServiceBus.ServiceBusConnection * string * Microsoft.Azure.ServiceBus.ReceiveMode * Microsoft.Azure.ServiceBus.RetryPolicy -> Microsoft.Azure.ServiceBus.QueueClientPublic Sub New (serviceBusConnection As ServiceBusConnection, entityPath As String, receiveMode As ReceiveMode, retryPolicy As RetryPolicy)Parameters
- serviceBusConnection
- ServiceBusConnection
Connection object to the service bus namespace.
- entityPath
- String
Queue path.
- receiveMode
- ReceiveMode
Mode of receive of messages. Default to ReceiveMode.PeekLock.
- retryPolicy
- RetryPolicy
Retry policy for queue operations. Defaults to Default
Applies to
QueueClient(String, String, ReceiveMode, RetryPolicy)
- Source:
- QueueClient.cs
Instantiates a new QueueClient to perform operations on a queue.
public QueueClient (string connectionString, string entityPath, Microsoft.Azure.ServiceBus.ReceiveMode receiveMode = Microsoft.Azure.ServiceBus.ReceiveMode.PeekLock, Microsoft.Azure.ServiceBus.RetryPolicy retryPolicy = default);new Microsoft.Azure.ServiceBus.QueueClient : string * string * Microsoft.Azure.ServiceBus.ReceiveMode * Microsoft.Azure.ServiceBus.RetryPolicy -> Microsoft.Azure.ServiceBus.QueueClientPublic Sub New (connectionString As String, entityPath As String, Optional receiveMode As ReceiveMode = Microsoft.Azure.ServiceBus.ReceiveMode.PeekLock, Optional retryPolicy As RetryPolicy = Nothing)Parameters
- connectionString
- String
Namespace connection string. Must not contain queue information.
- entityPath
- String
Name of the queue
- receiveMode
- ReceiveMode
Mode of receive of messages. Defaults to ReceiveMode.PeekLock.
- retryPolicy
- RetryPolicy
Retry policy for queue operations. Defaults to Default
Remarks
Creates a new connection to the queue, which is opened during the first send/receive operation.
Applies to
QueueClient(String, String, ITokenProvider, TransportType, ReceiveMode, RetryPolicy)
- Source:
- QueueClient.cs
Creates a new instance of the Queue client using the specified endpoint, entity path, and token provider.
public QueueClient (string endpoint, string entityPath, Microsoft.Azure.ServiceBus.Primitives.ITokenProvider tokenProvider, Microsoft.Azure.ServiceBus.TransportType transportType = Microsoft.Azure.ServiceBus.TransportType.Amqp, Microsoft.Azure.ServiceBus.ReceiveMode receiveMode = Microsoft.Azure.ServiceBus.ReceiveMode.PeekLock, Microsoft.Azure.ServiceBus.RetryPolicy retryPolicy = default);new Microsoft.Azure.ServiceBus.QueueClient : string * string * Microsoft.Azure.ServiceBus.Primitives.ITokenProvider * Microsoft.Azure.ServiceBus.TransportType * Microsoft.Azure.ServiceBus.ReceiveMode * Microsoft.Azure.ServiceBus.RetryPolicy -> Microsoft.Azure.ServiceBus.QueueClientPublic Sub New (endpoint As String, entityPath As String, tokenProvider As ITokenProvider, Optional transportType As TransportType = Microsoft.Azure.ServiceBus.TransportType.Amqp, Optional receiveMode As ReceiveMode = Microsoft.Azure.ServiceBus.ReceiveMode.PeekLock, Optional retryPolicy As RetryPolicy = Nothing)Parameters
- endpoint
- String
Fully qualified domain name for Service Bus. Most likely, {yournamespace}.servicebus.windows.net
- entityPath
- String
Queue path.
- tokenProvider
- ITokenProvider
Token provider which will generate security tokens for authorization.
- transportType
- TransportType
Transport type.
- receiveMode
- ReceiveMode
Mode of receive of messages. Defaults to ReceiveMode.PeekLock.
- retryPolicy
- RetryPolicy
Retry policy for queue operations. Defaults to Default
Remarks
Creates a new connection to the queue, which is opened during the first send/receive operation.
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for