[Service Bus] Clarify "Idle" for entities (Azure#48372)

jsquire · web-flow · commit 788d2a008561 · 2025-02-20T15:33:09.000-08:00
The focus of these changes is link to the Service
Bus docs to clarify the meaning of "idle" as applied
to Service Bus entities.
diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/CreateQueueOptions.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/CreateQueueOptions.cs
@@ -143,6 +143,7 @@ public TimeSpan DefaultMessageTimeToLive
         /// The <see cref="TimeSpan"/> idle interval after which the queue is automatically deleted.
         /// </summary>
         /// <remarks>The minimum duration is 5 minutes. Default value is <see cref="TimeSpan.MaxValue"/>.</remarks>
+        /// <seealso href="https://learn.microsoft.com/azure/service-bus-messaging/message-expiration#idleness">Service Bus: Idleness</seealso>
         public TimeSpan AutoDeleteOnIdle
         {
             get => autoDeleteOnIdle;
diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/CreateSubscriptionOptions.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/CreateSubscriptionOptions.cs
@@ -112,6 +112,7 @@ public TimeSpan DefaultMessageTimeToLive
         /// The <see cref="TimeSpan"/> idle interval after which the subscription is automatically deleted.
         /// </summary>
         /// <remarks>The minimum duration is 5 minutes. Default value is <see cref="TimeSpan.MaxValue"/>.</remarks>
+        /// <seealso href="https://learn.microsoft.com/azure/service-bus-messaging/message-expiration#idleness">Service Bus: Idleness</seealso>
         public TimeSpan AutoDeleteOnIdle
         {
             get => _autoDeleteOnIdle;
diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/CreateTopicOptions.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/CreateTopicOptions.cs
@@ -81,6 +81,7 @@ public TimeSpan DefaultMessageTimeToLive
         /// The <see cref="TimeSpan"/> idle interval after which the topic is automatically deleted.
         /// </summary>
         /// <remarks>The minimum duration is 5 minutes. Default value is <see cref="TimeSpan.MaxValue"/>.</remarks>
+        /// <seealso href="https://learn.microsoft.com/azure/service-bus-messaging/message-expiration#idleness">Service Bus: Idleness</seealso>
         public TimeSpan AutoDeleteOnIdle
         {
             get => _autoDeleteOnIdle;
diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/QueueProperties.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/QueueProperties.cs
@@ -138,6 +138,7 @@ public TimeSpan DefaultMessageTimeToLive
         /// The <see cref="TimeSpan"/> idle interval after which the queue is automatically deleted.
         /// </summary>
         /// <remarks>The minimum duration is 5 minutes. Default value is <see cref="TimeSpan.MaxValue"/>.</remarks>
+        /// <seealso href="https://learn.microsoft.com/azure/service-bus-messaging/message-expiration#idleness">Service Bus: Idleness</seealso>
         public TimeSpan AutoDeleteOnIdle
         {
             get => _autoDeleteOnIdle;
diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/SubscriptionProperties.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/SubscriptionProperties.cs
@@ -107,6 +107,7 @@ public TimeSpan DefaultMessageTimeToLive
         /// The <see cref="TimeSpan"/> idle interval after which the subscription is automatically deleted.
         /// </summary>
         /// <remarks>The minimum duration is 5 minutes. Default value is <see cref="TimeSpan.MaxValue"/>.</remarks>
+        /// <seealso href="https://learn.microsoft.com/azure/service-bus-messaging/message-expiration#idleness">Service Bus: Idleness</seealso>
         public TimeSpan AutoDeleteOnIdle
         {
             get => _autoDeleteOnIdle;
diff --git a/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/TopicProperties.cs b/sdk/servicebus/Azure.Messaging.ServiceBus/src/Administration/TopicProperties.cs
@@ -85,6 +85,7 @@ public TimeSpan DefaultMessageTimeToLive
         /// The <see cref="TimeSpan"/> idle interval after which the topic is automatically deleted.
         /// </summary>
         /// <remarks>The minimum duration is 5 minutes. Default value is <see cref="TimeSpan.MaxValue"/>.</remarks>
+        /// <seealso href="https://learn.microsoft.com/azure/service-bus-messaging/message-expiration#idleness">Service Bus: Idleness</seealso>
         public TimeSpan AutoDeleteOnIdle
         {
             get => _autoDeleteOnIdle;

Original file line number	Diff line number	Diff line change
`@@ -143,6 +143,7 @@ public TimeSpan DefaultMessageTimeToLive`
`143`	`143`	`/// The <see cref="TimeSpan"/> idle interval after which the queue is automatically deleted.`
`144`	`144`	`/// </summary>`
`145`	`145`	`/// <remarks>The minimum duration is 5 minutes. Default value is <see cref="TimeSpan.MaxValue"/>.</remarks>`
	`146`	`+ /// <seealso href="https://learn.microsoft.com/azure/service-bus-messaging/message-expiration#idleness">Service Bus: Idleness</seealso>`
`146`	`147`	`public TimeSpan AutoDeleteOnIdle`
`147`	`148`	`{`
`148`	`149`	`get => autoDeleteOnIdle;`
Original file line number	Diff line number	Diff line change
`@@ -112,6 +112,7 @@ public TimeSpan DefaultMessageTimeToLive`
`112`	`112`	`/// The <see cref="TimeSpan"/> idle interval after which the subscription is automatically deleted.`
`113`	`113`	`/// </summary>`
`114`	`114`	`/// <remarks>The minimum duration is 5 minutes. Default value is <see cref="TimeSpan.MaxValue"/>.</remarks>`
	`115`	`+ /// <seealso href="https://learn.microsoft.com/azure/service-bus-messaging/message-expiration#idleness">Service Bus: Idleness</seealso>`
`115`	`116`	`public TimeSpan AutoDeleteOnIdle`
`116`	`117`	`{`
`117`	`118`	`get => _autoDeleteOnIdle;`
Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,7 @@ public TimeSpan DefaultMessageTimeToLive`
`81`	`81`	`/// The <see cref="TimeSpan"/> idle interval after which the topic is automatically deleted.`
`82`	`82`	`/// </summary>`
`83`	`83`	`/// <remarks>The minimum duration is 5 minutes. Default value is <see cref="TimeSpan.MaxValue"/>.</remarks>`
	`84`	`+ /// <seealso href="https://learn.microsoft.com/azure/service-bus-messaging/message-expiration#idleness">Service Bus: Idleness</seealso>`
`84`	`85`	`public TimeSpan AutoDeleteOnIdle`
`85`	`86`	`{`
`86`	`87`	`get => _autoDeleteOnIdle;`
Original file line number	Diff line number	Diff line change
`@@ -138,6 +138,7 @@ public TimeSpan DefaultMessageTimeToLive`
`138`	`138`	`/// The <see cref="TimeSpan"/> idle interval after which the queue is automatically deleted.`
`139`	`139`	`/// </summary>`
`140`	`140`	`/// <remarks>The minimum duration is 5 minutes. Default value is <see cref="TimeSpan.MaxValue"/>.</remarks>`
	`141`	`+ /// <seealso href="https://learn.microsoft.com/azure/service-bus-messaging/message-expiration#idleness">Service Bus: Idleness</seealso>`
`141`	`142`	`public TimeSpan AutoDeleteOnIdle`
`142`	`143`	`{`
`143`	`144`	`get => _autoDeleteOnIdle;`
Original file line number	Diff line number	Diff line change
`@@ -107,6 +107,7 @@ public TimeSpan DefaultMessageTimeToLive`
`107`	`107`	`/// The <see cref="TimeSpan"/> idle interval after which the subscription is automatically deleted.`
`108`	`108`	`/// </summary>`
`109`	`109`	`/// <remarks>The minimum duration is 5 minutes. Default value is <see cref="TimeSpan.MaxValue"/>.</remarks>`
	`110`	`+ /// <seealso href="https://learn.microsoft.com/azure/service-bus-messaging/message-expiration#idleness">Service Bus: Idleness</seealso>`
`110`	`111`	`public TimeSpan AutoDeleteOnIdle`
`111`	`112`	`{`
`112`	`113`	`get => _autoDeleteOnIdle;`
Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,7 @@ public TimeSpan DefaultMessageTimeToLive`
`85`	`85`	`/// The <see cref="TimeSpan"/> idle interval after which the topic is automatically deleted.`
`86`	`86`	`/// </summary>`
`87`	`87`	`/// <remarks>The minimum duration is 5 minutes. Default value is <see cref="TimeSpan.MaxValue"/>.</remarks>`
	`88`	`+ /// <seealso href="https://learn.microsoft.com/azure/service-bus-messaging/message-expiration#idleness">Service Bus: Idleness</seealso>`
`88`	`89`	`public TimeSpan AutoDeleteOnIdle`
`89`	`90`	`{`
`90`	`91`	`get => _autoDeleteOnIdle;`