diff --git a/iothub/service/src/Common/Exceptions/ErrorCode.cs b/iothub/service/src/Common/Exceptions/ErrorCode.cs
index 42a758865f..c4e3987676 100644
--- a/iothub/service/src/Common/Exceptions/ErrorCode.cs
+++ b/iothub/service/src/Common/Exceptions/ErrorCode.cs
@@ -7,12 +7,10 @@
namespace Microsoft.Azure.Devices.Common.Exceptions
{
///
- /// Error codes for common IoT hub exceptions.
+ /// Error codes for common IoT hub response errors.
///
public enum ErrorCode
{
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
-
///
/// Used when the error code returned by the hub is unrecognized. If encountered, please report the issue so it can be added here.
///
@@ -93,7 +91,7 @@ public enum ErrorCode
///
/// A devices with the same Id was present multiple times in the input request for bulk device registry operations.
///
- /// For more information on bulk registry operations.
+ /// For more information on bulk registry operations, see .
///
///
DeviceDefinedMultipleTimes = 400011,
@@ -122,16 +120,23 @@ public enum ErrorCode
CannotRegisterModuleToModule = 400301,
// Unauthorized - 401
+
+ ///
+ /// The error is internal to IoT hub and is likely transient.
+ ///
+ [Obsolete("This error does should not be returned by the service.")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
IotHubNotFound = 401001,
///
/// The SAS token has expired or IoT hub couldn't authenticate the authentication header, rule, or key.
- /// For detailed information, see .
+ /// For more information, see .
///
IotHubUnauthorizedAccess = 401002,
///
- /// Unused error code. Service does not return it and neither does the SDK. Replaced by
+ /// Unused error code. Service does not return it and neither does the SDK.
+ /// Replaced by
///
[Obsolete("This error does not appear to be returned by the service.")]
[EditorBrowsable(EditorBrowsableState.Never)]
@@ -147,7 +152,8 @@ public enum ErrorCode
IotHubSuspended = 403001,
///
- /// The daily message quota for the IoT hub is exceeded.
+ /// Total number of messages on the hub exceeded the allocated quota. Increase units for this hub to increase the quota.
+ /// For more information on quota, please refer to .
///
IotHubQuotaExceeded = 403002,
@@ -163,7 +169,7 @@ public enum ErrorCode
/// You will need to receive and complete/reject the messages from the device-side before you can enqueue any additional messages.
/// If you want to discard the currently enqueued messages,
/// you can purge your device message queue.
- /// For more details on cloud-to-device message operations, see
+ /// For more information on cloud-to-device message operations, see .
///
DeviceMaximumQueueDepthExceeded = 403004,
@@ -177,7 +183,7 @@ public enum ErrorCode
// NotFound - 404
///
- /// The operation failed because the device cannot be found by IoT hub. The device is either not registered or disabled. May be thrown by operations such as
+ /// The operation failed because the device cannot be found by IoT hub. The device is either not registered or disabled. May be thrown by operations such as
/// .
///
DeviceNotFound = 404001,
@@ -191,14 +197,14 @@ public enum ErrorCode
///
/// The error is internal to IoT hub and is likely transient.
- /// For more details, see 503003 PartitionNotFound.
+ /// For more information, see 503003 PartitionNotFound.
///
[Obsolete("This error does should not be returned by the service.")]
[EditorBrowsable(EditorBrowsableState.Never)]
PartitionNotFound = 503003,
///
- /// The operation failed because the module cannot be found by IoT hub. The module is either not registered or disabled. May be thrown by operations such as
+ /// The operation failed because the module cannot be found by IoT hub. The module is either not registered or disabled. May be thrown by operations such as
/// .
///
ModuleNotFound = 404010,
@@ -212,7 +218,7 @@ public enum ErrorCode
///
/// The operation failed because it attempted to add a module to a device when that device already has a module registered to it with the same Id. This issue can be
- /// fixed by removing the existing module from the device first with . This error code is only returned from
+ /// fixed by removing the existing module from the device first with . This error code is only returned from
/// methods like .
///
ModuleAlreadyExistsOnDevice = 409301,
@@ -233,32 +239,43 @@ public enum ErrorCode
DeviceMessageLockLost = 412002,
// RequestEntityTooLarge - 413
+
///
/// 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 IoT hub quotas and throttling | Other limits
+ /// For more information on message sizes, see IoT hub quotas and throttling | Other limits
///
MessageTooLarge = 413001,
+ ///
+ /// Too many devices were included in the bulk operation. Check the response for details.
+ /// For more information, see .
+ ///
TooManyDevices = 413002,
+
+ ///
+ /// Unused error code. Service does not return it and neither does the SDK.
+ ///
+ [Obsolete("This error does not appear to be returned by the service.")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
TooManyModulesOnDevice = 413003,
// Throttling Exception
///
/// IoT hub throttling limits have been exceeded for the requested operation.
- /// For more information, IoT hub quotas and throttling.
+ /// For more information, IoT hub quotas and throttling.
///
ThrottlingException = 429001,
///
/// IoT hub throttling limits have been exceeded for the requested operation.
- /// For more information, IoT hub quotas and throttling.
+ /// For more information, see IoT hub quotas and throttling.
///
ThrottleBacklogLimitExceeded = 429002,
///
/// IoT hub ran into a server side issue when attempting to throttle.
- /// For more information, 500xxx Internal errors.
+ /// For more information, see 500xxx Internal errors.
///
[Obsolete("This error does not appear to be returned by the service.")]
[EditorBrowsable(EditorBrowsableState.Never)]
@@ -274,6 +291,11 @@ public enum ErrorCode
///
ServerError = 500001,
+ ///
+ /// Unused error code. Service does not return it and neither does the SDK.
+ ///
+ [Obsolete("This error does not appear to be returned by the service.")]
+ [EditorBrowsable(EditorBrowsableState.Never)]
JobCancelled = 500002,
// ServiceUnavailable
@@ -282,7 +304,5 @@ public enum ErrorCode
/// IoT hub is currently unable to process the request. This is a transient, retryable error.
///
ServiceUnavailable = 503001,
-
-#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
}
}