Document InvalidOperation and ArgumentInvalid (#2089)

Azure · Jul 12, 2021 · e329559 · e329559
1 parent 6aca09e
commit e329559
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/iothub/service/src/Common/Exceptions/ErrorCode.cs b/iothub/service/src/Common/Exceptions/ErrorCode.cs
@@ -35,8 +35,21 @@ public enum ErrorCode
         [EditorBrowsable(EditorBrowsableState.Never)]
         DeviceInvalidResultCount = 400002,
 
+        /// <summary>
+        /// The client has requested an operation that the hub recognizes as invalid. Check the error message
+        /// for more information about what is invalid.
+        /// </summary>
+        // Note: although infrequent, this does appear in logs for "Amqp Message.Properties.To must contain the device identifier".
+        // and perhaps other cases.
         InvalidOperation = 400003,
+
+        /// <summary>
+        /// Something in the request payload is invalid. Check the error message for more information about what
+        /// is invalid.
+        /// </summary>
+        // Note: one example found in logs is for invalid characters in a twin property name.
         ArgumentInvalid = 400004,
+
         ArgumentNull = 400005,
         IotHubFormatError = 400006,