Add comprehensive TROUBLESHOOTING.md file for Azure Service Bus Python SDK

[Copilot]

Summary

This PR adds a comprehensive TROUBLESHOOTING.md file to the Azure Service Bus Python SDK directory (sdk/servicebus/azure-servicebus/) to provide developers with clear guidance on diagnosing and resolving common issues.

Addresses: #36334

What's Changed

• New file: sdk/servicebus/azure-servicebus/TROUBLESHOOTING.md (421 lines)
• Follows the established pattern of other Azure SDK troubleshooting guides (App Configuration, Event Hubs)
• Extracts and expands on existing troubleshooting content from the README.md

Content Overview

The troubleshooting guide includes the following sections:

🔧 General Troubleshooting

• Client logging setup with AMQP frame tracing
• Comprehensive list of all Service Bus exceptions with descriptions and resolution steps
• Timeout configurations and best practices

🔐 Authentication & Authorization Issues

• Connection string problems and validation
• Credential configuration (SAS tokens, Managed Identity, Azure Identity)
• Permission requirements for different operations
• Role-based access control (RBAC) guidance

🌐 Connectivity Issues

• Network connectivity troubleshooting
• Firewall and proxy configuration
• AMQP over WebSockets for restricted environments
• Service busy error handling

📨 Message Handling Issues

• Message lock management and AutoLockRenewer usage
• Message size limits and batch optimization
• Message settlement patterns and error handling
• Dead letter queue debugging techniques

🎯 Session Handling Issues

• Session lock management
• Session-specific error resolution
• Multi-client session coordination

📊 Quota & Capacity Issues

• Entity size and message count limits
• Connection limits and scaling guidance
• Service tier considerations

❓ Frequently Asked Questions

• Common developer scenarios and solutions
• Performance optimization tips
• Best practices for error handling

🆘 Getting Help

• GitHub issue filing guidelines
• Required information for effective troubleshooting
• Links to additional resources

Key Features

• Practical code examples for common scenarios like connection setup, error handling, and lock renewal
• Clear resolution steps for each category of issues
• Service Bus-specific guidance not found in general Azure SDK documentation
• Consistent formatting following Azure SDK documentation standards
• Comprehensive exception reference with actionable remediation steps

Benefits for Developers

This troubleshooting guide will help developers:

• Quickly diagnose and resolve common Service Bus issues
• Understand Service Bus-specific concepts like message locks and sessions
• Implement proper error handling and retry logic
• Configure authentication and connectivity correctly
• Optimize performance and avoid common pitfalls

The file serves as a centralized resource for Service Bus troubleshooting, reducing the need to search through multiple documentation sources or GitHub issues.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[Copilot]

@copilot AVOID condensing sections that I said to remove. These sections should be removed entirely, including the header. Also, address ALL comments.

I've addressed the feedback by removing the "Threading and concurrency issues" section entirely rather than condensing it. This section contained general Python patterns rather than Service Bus-specific troubleshooting. The guide now focuses exclusively on Service Bus-specific issues. Commit: b684064

[swathipil]

@copilot undo the previous 2 commits

[Copilot]

@copilot undo the previous 2 commits

Undone the previous 2 commits as requested. The TROUBLESHOOTING.md file has been restored to the state before commits b684064 and 80409e2. The file now includes the threading and concurrency section and the client options references.

[swathipil]

@copilot - undo changes from commits b684064 and 80409e2

[Copilot]

@copilot - undo changes from commits b684064 and 80409e23bdce...

Undone the changes from commits b684064 and 80409e2 as requested. The TROUBLESHOOTING.md file has been restored to include the threading and concurrency section and the client options references. Commit: 564e323