[FEATURE REQ] Align ProcessSessionMessageEventArgs.DeadLetterMessageAsync overload parameter types

[kimsey0]

Library name

Azure.Messaging.ServiceBus

Please describe the feature.

ProcessSessionMessageEventArgs has three methods which take IDictionary<string, object> propertiesToModify parameters: AbandonMessageAsync, DeferMessageAsync, and DeadLetterMessageAsync.

azure-sdk-for-net/sdk/servicebus/Azure.Messaging.ServiceBus/src/Processor/ProcessSessionMessageEventArgs.cs

Lines 199 to 202 in ff64938

	public virtual async Task DeadLetterMessageAsync(
	ServiceBusReceivedMessage message,
	IDictionary<string, object> propertiesToModify = default,
	CancellationToken cancellationToken = default)

However, it also has one DeadLetterMessageAsync overload which takes a Dictionary<string, object>.

azure-sdk-for-net/sdk/servicebus/Azure.Messaging.ServiceBus/src/Processor/ProcessSessionMessageEventArgs.cs

Lines 213 to 218 in ff64938

	public virtual async Task DeadLetterMessageAsync(
	ServiceBusReceivedMessage message,
	Dictionary<string, object> propertiesToModify,
	string deadLetterReason,
	string deadLetterErrorDescription = default,
	CancellationToken cancellationToken = default)

Can this one be changed to take an IDictionary<string, object>, aligning it with the other three?

[github-actions]

Thank you for your feedback. Tagging and routing to the team member best able to assist.

[JoshLove-msft]

Thank you for bringing this issue to our attention @kimsey0. Unfortunately changing the type from Dictionary to IDictionary would be a binary break. I think we may have to live with this inconsistency.

[github-actions]

Hi @kimsey0. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text "/unresolve" to remove the "issue-addressed" label and continue the conversation.