diff --git a/iothub/service/src/Common/Exceptions/ErrorCode.cs b/iothub/service/src/Common/Exceptions/ErrorCode.cs index 5c16184b65..42a758865f 100644 --- a/iothub/service/src/Common/Exceptions/ErrorCode.cs +++ b/iothub/service/src/Common/Exceptions/ErrorCode.cs @@ -56,6 +56,10 @@ public enum ErrorCode // Note: an example suggested is null method payloads, but our client converts null to a JSON null, which is allowed. ArgumentNull = 400005, + /// + /// Returned by the service if a JSON object provided by this library cannot be parsed. For instance, if the JSON provided for + /// is invalid. + /// IotHubFormatError = 400006, /// @@ -108,8 +112,6 @@ public enum ErrorCode /// request or user input. /// /// - //[Obsolete("This error does not appear to be returned by the service.")] - //[EditorBrowsable(EditorBrowsableState.Never)] BulkRegistryOperationFailure = 400013, /// @@ -175,7 +177,8 @@ 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. + /// 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, @@ -187,13 +190,17 @@ public enum ErrorCode JobNotFound = 404002, /// - /// The error is internal to IoT Hub and is likely transient. + /// The error is internal to IoT hub and is likely transient. /// For more details, 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 + /// . + /// ModuleNotFound = 404010, // Conflict - 409 @@ -203,6 +210,11 @@ public enum ErrorCode /// DeviceAlreadyExists = 409001, + /// + /// 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 + /// methods like . + /// ModuleAlreadyExistsOnDevice = 409301, /// @@ -222,8 +234,8 @@ public enum ErrorCode // 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 + /// 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 /// MessageTooLarge = 413001, @@ -234,13 +246,13 @@ public enum ErrorCode /// /// 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, IoT hub quotas and throttling. /// ThrottleBacklogLimitExceeded = 429002,