[Service Bus] Support MaxMessageSizeInKilobytes

sdk/servicebus/service-bus/CHANGELOG.md

@@ -1,9 +1,11 @@
 # Release History
 
-## 7.3.1 (Unreleased)
+## 7.3.1-beta.1 (Unreleased)
 
 ### Features Added
 
+- Adds new get/set property `maxMessageSizeInKilobytes` to `QueueProperties`, `TopicProperties`, `CreateQueueOptions`, and `CreateTopicOptions`. Only applicable for premium namespaces. Use this when creating or updating queues and topics. Added in [#17953](https://github.com/Azure/azure-sdk-for-js/pull/17953)
+
 ### Breaking Changes
 
 ### Bugs Fixed

sdk/servicebus/service-bus/package.json

@@ -2,7 +2,7 @@
   "name": "@azure/service-bus",
   "sdk-type": "client",
   "author": "Microsoft Corporation",
-  "version": "7.3.1",
+  "version": "7.3.1-beta.1",
   "license": "MIT",
   "description": "Azure Service Bus SDK for JavaScript",
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/servicebus/service-bus/",

sdk/servicebus/service-bus/review/service-bus.api.md

@@ -74,6 +74,7 @@ export interface CreateQueueOptions extends OperationOptions {
     forwardTo?: string;
     lockDuration?: string;
     maxDeliveryCount?: number;
+    maxMessageSizeInKilobytes?: number;
     maxSizeInMegabytes?: number;
     requiresDuplicateDetection?: boolean;
     requiresSession?: boolean;
@@ -113,6 +114,7 @@ export interface CreateTopicOptions extends OperationOptions {
     enableBatchedOperations?: boolean;
     enableExpress?: boolean;
     enablePartitioning?: boolean;
+    maxMessageSizeInKilobytes?: number;
     maxSizeInMegabytes?: number;
     requiresDuplicateDetection?: boolean;
     status?: EntityStatus;
@@ -199,6 +201,7 @@ export interface QueueProperties {
     forwardTo?: string;
     lockDuration: string;
     maxDeliveryCount: number;
+    maxMessageSizeInKilobytes: number;
     maxSizeInMegabytes: number;
     readonly name: string;
     readonly requiresDuplicateDetection: boolean;
@@ -551,6 +554,7 @@ export interface TopicProperties {
     enableBatchedOperations: boolean;
     readonly enableExpress: boolean;
     readonly enablePartitioning: boolean;
+    maxMessageSizeInKilobytes: number;
     maxSizeInMegabytes: number;
     readonly name: string;
     readonly requiresDuplicateDetection: boolean;

sdk/servicebus/service-bus/sample.env

@@ -1,4 +1,4 @@
-# Used in most samples. Retrieve these values from a storage account in the Azure Portal.
+# Used in most samples. Retrieve these values from a service-bus namespace in the Azure Portal.
 SERVICEBUS_ENDPOINT="<service bus namespace>.servicebus.windows.net"
 SERVICEBUS_CONNECTION_STRING="<connection string>"
 
@@ -23,4 +23,4 @@ AZURE_CLIENT_ID=<ID of the user/service principal to authenticate as>
 AZURE_CLIENT_SECRET=<client secret used to authenticate to Azure AD>
 
 # To run the useProxy sample, set up an HTTP proxy and enter your information:
-# HTTP_PROXY=http://localhost:3128
+# HTTP_PROXY=http://localhost:3128

sdk/servicebus/service-bus/src/serializers/queueResourceSerializer.ts

@@ -55,7 +55,8 @@ export function buildQueueOptions(queue: CreateQueueOptions): InternalQueueOptio
     EnablePartitioning: getStringOrUndefined(queue.enablePartitioning),
     ForwardDeadLetteredMessagesTo: getStringOrUndefined(queue.forwardDeadLetteredMessagesTo),
     EntityAvailabilityStatus: getStringOrUndefined(queue.availabilityStatus),
-    EnableExpress: getStringOrUndefined(queue.enableExpress)
+    EnableExpress: getStringOrUndefined(queue.enableExpress),
+    MaxMessageSizeInKilobytes: getStringOrUndefined(queue.maxMessageSizeInKilobytes)
   };
 }
 
@@ -111,7 +112,12 @@ export function buildQueue(rawQueue: Record<string, any>): QueueProperties {
 
     enableExpress: getBoolean(rawQueue[Constants.ENABLE_EXPRESS], "enableExpress"),
 
-    availabilityStatus: rawQueue[Constants.ENTITY_AVAILABILITY_STATUS]
+    availabilityStatus: rawQueue[Constants.ENTITY_AVAILABILITY_STATUS],
+
+    maxMessageSizeInKilobytes: getInteger(
+      rawQueue[Constants.MAX_MESSAGE_SIZE_IN_KILOBYTES],
+      "maxMessageSizeInKilobytes"
+    )
   };
 }
 
@@ -156,6 +162,13 @@ export interface CreateQueueOptions extends OperationOptions {
    */
   maxSizeInMegabytes?: number;
 
+  /**
+   * The maximum message size in kilobytes for messages sent to this queue.
+   *
+   * (Configurable only for Premium Tier Service Bus namespace.)
+   */
+  maxMessageSizeInKilobytes?: number;
+
   /**
    * If enabled, the topic will detect duplicate messages within the time
    * span specified by the DuplicateDetectionHistoryTimeWindow property.
@@ -299,6 +312,11 @@ export interface QueueProperties {
    */
   maxSizeInMegabytes: number;
 
+  /**
+   * The maximum message size in kilobytes for messages sent to this queue.
+   */
+  maxMessageSizeInKilobytes: number;
+
   /**
    * If enabled, the topic will detect duplicate messages within the time
    * span specified by the DuplicateDetectionHistoryTimeWindow property.
@@ -436,6 +454,11 @@ export interface InternalQueueOptions {
    */
   MaxSizeInMegabytes?: string;
 
+  /**
+   * The maximum message size in kilobytes for messages sent to this queue/topic.
+   */
+  MaxMessageSizeInKilobytes?: string;
+
   /**
    *  If enabled, the topic will detect duplicate messages within the time
    * span specified by the DuplicateDetectionHistoryTimeWindow property.

sdk/servicebus/service-bus/src/serializers/topicResourceSerializer.ts

@@ -50,7 +50,8 @@ export function buildTopicOptions(topic: CreateTopicOptions): InternalTopicOptio
     AutoDeleteOnIdle: getStringOrUndefined(topic.autoDeleteOnIdle),
     EnablePartitioning: getStringOrUndefined(topic.enablePartitioning),
     EntityAvailabilityStatus: getStringOrUndefined(topic.availabilityStatus),
-    EnableExpress: getStringOrUndefined(topic.enableExpress)
+    EnableExpress: getStringOrUndefined(topic.enableExpress),
+    MaxMessageSizeInKilobytes: getStringOrUndefined(topic.maxMessageSizeInKilobytes)
   };
 }
 
@@ -93,7 +94,12 @@ export function buildTopic(rawTopic: Record<string, any>): TopicProperties {
 
     enableExpress: getBoolean(rawTopic[Constants.ENABLE_EXPRESS], "enableExpress"),
 
-    availabilityStatus: rawTopic[Constants.ENTITY_AVAILABILITY_STATUS]
+    availabilityStatus: rawTopic[Constants.ENTITY_AVAILABILITY_STATUS],
+
+    maxMessageSizeInKilobytes: getInteger(
+      rawTopic[Constants.MAX_MESSAGE_SIZE_IN_KILOBYTES],
+      "maxMessageSizeInKilobytes"
+    )
   };
 }
 
@@ -142,6 +148,13 @@ export interface CreateTopicOptions extends OperationOptions {
    */
   maxSizeInMegabytes?: number;
 
+  /**
+   * The maximum message size in kilobytes for messages sent to this topic.
+   *
+   * (Configurable only for Premium Tier Service Bus namespace.)
+   */
+  maxMessageSizeInKilobytes?: number;
+
   /**
    * If enabled, the topic will detect duplicate messages within the time span
    * specified by the DuplicateDetectionHistoryTimeWindow property.
@@ -243,6 +256,11 @@ export interface TopicProperties {
    */
   maxSizeInMegabytes: number;
 
+  /**
+   * The maximum message size in kilobytes for messages sent to this queue/topic.
+   */
+  maxMessageSizeInKilobytes: number;
+
   /**
    * If enabled, the topic will detect duplicate messages within the time span
    * specified by the DuplicateDetectionHistoryTimeWindow property.
@@ -339,6 +357,12 @@ export interface InternalTopicOptions {
    */
   MaxSizeInMegabytes?: string;
 
+  /**
+   * The maximum message size in kilobytes for messages sent to this queue/topic
+   *
+   */
+  MaxMessageSizeInKilobytes?: string;
+
   /**
    * If enabled, the topic will detect duplicate messages within the time span
    * specified by the DuplicateDetectionHistoryTimeWindow property.

sdk/servicebus/service-bus/src/util/constants.ts

@@ -6,7 +6,7 @@
  */
 export const packageJsonInfo = {
   name: "@azure/service-bus",
-  version: "7.3.1"
+  version: "7.3.1-beta.1"
 };
 
 /**
@@ -172,7 +172,12 @@ export const USER_METADATA = "UserMetadata";
  * @internal
  */
 export const MAX_SIZE_IN_MEGABYTES = "MaxSizeInMegabytes";
-
+/**
+ * The maximum size in kilobytes.
+ *
+ * @internal
+ */
+export const MAX_MESSAGE_SIZE_IN_KILOBYTES = "MaxMessageSizeInKilobytes";
 /**
  * The default message time to live.
  * This is specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds.
@@ -273,7 +278,7 @@ export const API_VERSION_QUERY_KEY = "api-version";
  *
  * @internal
  */
-export const CURRENT_API_VERSION = "2017-04";
+export const CURRENT_API_VERSION = "2021-05";
 
 /**
  * Constant representing the Odata Error 'message' property

sdk/servicebus/service-bus/test.env

@@ -0,0 +1,10 @@
+# Used in most tests. Retrieve this value from a service-bus namespace in the Azure Portal.
+SERVICEBUS_CONNECTION_STRING="<connection string>"
+
+# Used in a couple of tests
+SERVICEBUS_CONNECTION_STRING_PREMIUM="<connection string>"
+
+# Used to authenticate using Azure AD as a service principal for role-based authentication.
+AZURE_TENANT_ID=<AD tenant id or name>
+AZURE_CLIENT_ID=<ID of the user/service principal to authenticate as>
+AZURE_CLIENT_SECRET=<client secret used to authenticate to Azure AD>