Client Options Class
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.
Provides the client configuration options for connecting to Azure Queue Storage
public class QueueClientOptions : Azure.Core.ClientOptions
type QueueClientOptions = class inherit ClientOptions
Public Class QueueClientOptions Inherits ClientOptions
Initializes a new instance of the QueueClientOptions class.
Gets the client diagnostic options.(Inherited from ClientOptions)
Enables tenant discovery through the authorization challenge when the client is configured to use a TokenCredential. When enabled, the client will attempt an initial un-authorized request to prompt a challenge in order to discover the correct tenant for the resource.
Gets or sets the secondary storage Uri that can be read from for the storage account if the account is enabled for RA-GRS.
If this property is set, the secondary Uri will be used for GET or HEAD requests during retries. If the status of the response from the secondary Uri is a 404, then subsequent retries for the request will not use the secondary Uri again, as this indicates that the resource may not have propagated there yet. Otherwise, subsequent retries will alternate back and forth between primary and secondary Uri.
Gets the client retry options.(Inherited from ClientOptions)
Adds an HttpPipeline policy into the client pipeline. The position of policy in the pipeline is controlled by
Optional. Performs the tasks needed when a message is received or peaked from the queue but cannot be decoded.
Such message can be received or peaked when QueueClient is expecting certain QueueMessageEncoding but there's another producer that is not encoding messages in expected way. I.e. the queue contains messages with different encoding.
QueueMessageDecodingFailedEventArgs contains QueueClient that has received the message as well as ReceivedMessage or PeekedMessage with raw body, i.e. no decoding will be attempted so that body can be inspected as has been received from the queue.
The QueueClient won't attempt to remove the message from the queue. Therefore such handling should be included into the event handler itself.
The handler is potentially invoked by both synchronous and asynchronous receive and peek APIs. Therefore implementation of the handler should align with QueueClient APIs that are being used. See SyncAsyncEventHandler<T> about how to implement handler correctly. The example below shows a handler with all possible cases explored.