Improve the rule manager documentation (#34815)

Azure · Mar 9, 2023 · 0618f36 · 0618f36
1 parent c3aa137
commit 0618f36
Showing 1 changed file with 101 additions and 0 deletions.
diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/RuleManager/ServiceBusRuleManager.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/RuleManager/ServiceBusRuleManager.cs
@@ -129,6 +129,42 @@ protected ServiceBusRuleManager() { }
         /// Multiple filters combine with each other using logical OR condition. i.e., If any filter succeeds, the message is passed on to the subscription.
         /// </remarks>
         ///
+        /// <exception cref="ServiceBusException">
+        ///   <list type="bullet">
+        ///     <item>
+        ///       <description>
+        ///         A rule with the same name exists under the subscription. The <see cref="ServiceBusException.Reason" /> will be set to
+        ///         <see cref="ServiceBusFailureReason.MessagingEntityAlreadyExists"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///     <item>
+        ///       <description>
+        ///         The operation timed out. The <see cref="ServiceBusException.Reason" /> will be set to
+        ///         <see cref="ServiceBusFailureReason.ServiceTimeout"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///     <item>
+        ///       <description>
+        ///         Either the specified size of the entity is not supported or the maximum allowable quota has been reached.
+        ///         You must specify one of the supported size values, delete existing entities, or increase your quota size.
+        ///         The failure reason will be set to <see cref="ServiceBusFailureReason.QuotaExceeded"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///     <item>
+        ///       <description>
+        ///         The server is busy. You should wait before you retry the operation. The failure reason will be set to
+        ///         <see cref="ServiceBusFailureReason.ServiceBusy"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///     <item>
+        ///       <description>
+        ///         An internal error or unexpected exception occurs. The failure reason will be set to
+        ///         <see cref="ServiceBusFailureReason.GeneralError"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///   </list>
+        /// </exception>
+        ///
         /// <returns>A task instance that represents the asynchronous add rule operation.</returns>
         public virtual async Task CreateRuleAsync(
             string ruleName,
@@ -152,6 +188,42 @@ public virtual async Task CreateRuleAsync(
         /// Multiple filters combine with each other using logical OR condition. i.e., If any filter succeeds, the message is passed on to the subscription.
         /// </remarks>
         ///
+        /// <exception cref="ServiceBusException">
+        ///   <list type="bullet">
+        ///     <item>
+        ///       <description>
+        ///         A rule with the same name exists under the subscription. The <see cref="ServiceBusException.Reason" /> will be set to
+        ///         <see cref="ServiceBusFailureReason.MessagingEntityAlreadyExists"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///     <item>
+        ///       <description>
+        ///         The operation timed out. The <see cref="ServiceBusException.Reason" /> will be set to
+        ///         <see cref="ServiceBusFailureReason.ServiceTimeout"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///     <item>
+        ///       <description>
+        ///         Either the specified size of the entity is not supported or the maximum allowable quota has been reached.
+        ///         You must specify one of the supported size values, delete existing entities, or increase your quota size.
+        ///         The failure reason will be set to <see cref="ServiceBusFailureReason.QuotaExceeded"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///     <item>
+        ///       <description>
+        ///         The server is busy. You should wait before you retry the operation. The failure reason will be set to
+        ///         <see cref="ServiceBusFailureReason.ServiceBusy"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///     <item>
+        ///       <description>
+        ///         An internal error or unexpected exception occurs. The failure reason will be set to
+        ///         <see cref="ServiceBusFailureReason.GeneralError"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///   </list>
+        /// </exception>
+        ///
         /// <returns>A task instance that represents the asynchronous add rule operation.</returns>
         public virtual async Task CreateRuleAsync(
             CreateRuleOptions options,
@@ -191,6 +263,35 @@ await InnerRuleManager.CreateRuleAsync(
         /// <param name="ruleName">Name of the rule</param>
         /// <param name="cancellationToken">An optional <see cref="CancellationToken"/> instance to signal the request to cancel the operation.</param>
         ///
+        /// <exception cref="ServiceBusException">
+        ///   <list type="bullet">
+        ///     <item>
+        ///       <description>
+        ///         The specified entity could not be found. The <see cref="ServiceBusException.Reason" /> will be set to
+        ///         <see cref="ServiceBusFailureReason.MessagingEntityNotFound"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///     <item>
+        ///       <description>
+        ///         The operation timed out. The <see cref="ServiceBusException.Reason" /> will be set to
+        ///         <see cref="ServiceBusFailureReason.ServiceTimeout"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///     <item>
+        ///       <description>
+        ///         The server is busy. You should wait before you retry the operation. The failure reason will be set to
+        ///         <see cref="ServiceBusFailureReason.ServiceBusy"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///     <item>
+        ///       <description>
+        ///         An internal error or unexpected exception occurs. The failure reason will be set to
+        ///         <see cref="ServiceBusFailureReason.GeneralError"/> in this case.
+        ///       </description>
+        ///     </item>
+        ///   </list>
+        /// </exception>
+        ///
         /// <returns>A task instance that represents the asynchronous remove rule operation.</returns>
         public virtual async Task DeleteRuleAsync(
             string ruleName,