[Error Codes] Updated MessageTooLarge (#2073)

* [Error Codes] Updated MessageTooLarge * Removed en-us where seen * Remove en-us * REmove en-us
Azure · Jul 9, 2021 · 421f23e · 421f23e
1 parent e061ca1
commit 421f23e
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/iothub/device/src/Common/Exceptions/MessageTooLargeException.cs b/iothub/device/src/Common/Exceptions/MessageTooLargeException.cs
@@ -10,6 +10,9 @@ namespace Microsoft.Azure.Devices.Client.Exceptions
     /// <summary>
     /// The exception that is thrown when an attempt to send a message fails because the length of the message exceeds the maximum size allowed.
     /// </summary>
+    /// <remarks>
+    /// When the message is too large for IoT Hub you will receive this exception. You should attempt to reduce your message size and send again. For more information on message sizes, see <see href="https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-quotas-throttling#other-limits">IoT Hub quotas and throttling | Other limits</see>
+    /// </remarks>
     [Serializable]
     public sealed class MessageTooLargeException : IotHubException
     {

diff --git a/iothub/service/src/Common/Exceptions/ErrorCode.cs b/iothub/service/src/Common/Exceptions/ErrorCode.cs
@@ -176,6 +176,9 @@ public enum ErrorCode
         DeviceMessageLockLost = 412002,
 
         // RequestEntityTooLarge - 413
+        /// <summary>
+        /// When the message is too large for IoT Hub you will receive this error. You should attempt to reduce your message size and send again. For more information on message sizes, see <see href="https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-quotas-throttling#other-limits">IoT Hub quotas and throttling | Other limits</see>
+        /// </summary>
         MessageTooLarge = 413001,
 
         TooManyDevices = 413002,
@@ -185,7 +188,7 @@ public enum ErrorCode
 
         /// <summary>
         /// IoT hub throttling limits have been exceeded for the requested operation.
-        /// For more information, <see href="https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-quotas-throttling"/>
+        /// For more information, <see href="https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-quotas-throttling"/>
         /// </summary>
         ThrottlingException = 429001,
 

diff --git a/iothub/service/src/Common/Exceptions/MessageTooLargeException.cs b/iothub/service/src/Common/Exceptions/MessageTooLargeException.cs
@@ -7,8 +7,11 @@
 namespace Microsoft.Azure.Devices.Common.Exceptions
 {
     /// <summary>
-    /// The exception that is thrown when a message is sent to IoT Hub that exceeds the maximum allowed bytes in size.
+    /// The exception that is thrown when an attempt to send a message fails because the length of the message exceeds the maximum size allowed.
     /// </summary>
+    /// <remarks>
+    /// When the message is too large for IoT Hub you will receive this exception. You should attempt to reduce your message size and send again. For more information on message sizes, see <see href="https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-quotas-throttling#other-limits">IoT Hub quotas and throttling | Other limits</see>
+    /// </remarks>
     [Serializable]
     public sealed class MessageTooLargeException : IotHubException
     {