@gradientedge/cdk-utils 9.40.0 → 9.41.0

package/dist/src/lib/azure/common/construct.d.ts

@@ -2,6 +2,7 @@ import { TerraformStack } from 'cdktf';
 import { Construct } from 'constructs';
 import { AzureStorageManager, AzureKeyVaultManager, AzureApiManagementManager, AzureFunctionManager, AzureResourceGroupManager, AzureAppServiceManager, AzureApplicationInsightsManager, AzureAppConfigurationManager, AzureCosmosDbManager, AzureServicebusManager, AzureEventgridManager, AzureDnsManager, AzureLogAnalyticsWorkspaceManager } from '../services';
 import { CommonAzureStackProps } from './types';
+import { AzureResourceNameFormatter } from './resource-name-formatter';
 export declare class CommonAzureConstruct extends TerraformStack {
     props: CommonAzureStackProps;
     apiManagementManager: AzureApiManagementManager;
@@ -17,6 +18,7 @@ export declare class CommonAzureConstruct extends TerraformStack {
     keyVaultManager: AzureKeyVaultManager;
     logAnalyticsWorkspaceManager: AzureLogAnalyticsWorkspaceManager;
     resourceGroupManager: AzureResourceGroupManager;
+    resourceNameFormatter: AzureResourceNameFormatter;
     servicebusManager: AzureServicebusManager;
     storageManager: AzureStorageManager;
     tenantId: string;

package/dist/src/lib/azure/common/construct.js

@@ -8,6 +8,7 @@ const cdktf_1 = require("cdktf");
 const common_1 = require("../../common");
 const services_1 = require("../services");
 const constants_1 = require("./constants");
+const resource_name_formatter_1 = require("./resource-name-formatter");
 class CommonAzureConstruct extends cdktf_1.TerraformStack {
     apiManagementManager;
     appConfigurationManager;
@@ -22,6 +23,7 @@ class CommonAzureConstruct extends cdktf_1.TerraformStack {
     keyVaultManager;
     logAnalyticsWorkspaceManager;
     resourceGroupManager;
+    resourceNameFormatter;
     servicebusManager;
     storageManager;
     tenantId;
@@ -40,6 +42,7 @@ class CommonAzureConstruct extends cdktf_1.TerraformStack {
         this.keyVaultManager = new services_1.AzureKeyVaultManager();
         this.logAnalyticsWorkspaceManager = new services_1.AzureLogAnalyticsWorkspaceManager();
         this.resourceGroupManager = new services_1.AzureResourceGroupManager();
+        this.resourceNameFormatter = new resource_name_formatter_1.AzureResourceNameFormatter(this, `${id}-rnf`, props);
         this.servicebusManager = new services_1.AzureServicebusManager();
         this.storageManager = new services_1.AzureStorageManager();
         this.determineFullyQualifiedDomain();

package/dist/src/lib/azure/common/resource-name-formatter.d.ts

@@ -0,0 +1,14 @@
+import { Construct } from 'constructs';
+import { AzureResourceNameFormatterProps } from './types';
+import { CommonAzureStackProps } from './types';
+export declare class AzureResourceNameFormatter extends Construct {
+    props: CommonAzureStackProps;
+    constructor(parent: Construct, id: string, props: CommonAzureStackProps);
+    /**
+     * @summary Helper method to format azure resource name based on the provided options
+     * @param resourceName The azure resource name to format
+     * @param options Options to control the formatting of the resource name
+     * @returns The formatted Azure-compliant resource name
+     */
+    format(resourceName: string, options?: AzureResourceNameFormatterProps): string;
+}

package/dist/src/lib/azure/common/resource-name-formatter.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AzureResourceNameFormatter = void 0;
+const constructs_1 = require("constructs");
+class AzureResourceNameFormatter extends constructs_1.Construct {
+    props;
+    constructor(parent, id, props) {
+        super(parent, id);
+        this.props = props;
+    }
+    /**
+     * @summary Helper method to format azure resource name based on the provided options
+     * @param resourceName The azure resource name to format
+     * @param options Options to control the formatting of the resource name
+     * @returns The formatted Azure-compliant resource name
+     */
+    format(resourceName, options) {
+        const azureResourceNameElements = [];
+        if (!options?.exclude) {
+            azureResourceNameElements.push(options?.globalPrefix ? this.props.globalPrefix : undefined);
+            azureResourceNameElements.push(options?.prefix ?? this.props.resourcePrefix);
+        }
+        azureResourceNameElements.push(resourceName);
+        if (!options?.exclude) {
+            azureResourceNameElements.push(options?.suffix ?? this.props.resourceSuffix);
+            azureResourceNameElements.push(options?.globalSuffix ? this.props.globalSuffix : undefined);
+        }
+        azureResourceNameElements.push(this.props.stage);
+        return azureResourceNameElements.filter(Boolean).join('-');
+    }
+}
+exports.AzureResourceNameFormatter = AzureResourceNameFormatter;

package/dist/src/lib/azure/common/types.d.ts

@@ -7,7 +7,21 @@ import { AzurermBackendConfig } from 'cdktf';
 export interface CommonAzureStackProps extends BaseProps, AzurermProviderConfig {
     resourceGroupName?: string;
     remoteBackend?: AzureRemoteBackendProps;
+    globalPrefix?: string;
+    globalSuffix?: string;
+    resourcePrefix?: string;
+    resourceSuffix?: string;
+    resourceNameOptions?: {
+        [key: string]: AzureResourceNameFormatterProps;
+    };
 }
 export interface AzureRemoteBackendProps extends AzurermBackendConfig {
     type: AzureRemoteBackend;
 }
+export interface AzureResourceNameFormatterProps {
+    exclude?: boolean;
+    globalPrefix?: boolean;
+    globalSuffix?: boolean;
+    prefix?: string;
+    suffix?: string;
+}

package/dist/src/lib/azure/services/api-management/main.js

@@ -43,9 +43,7 @@ class AzureApiManagementManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-am-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;

package/dist/src/lib/azure/services/app-configuration/main.js

@@ -33,9 +33,7 @@ class AzureAppConfigurationManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-am-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;

package/dist/src/lib/azure/services/app-service/main.js

@@ -33,15 +33,13 @@ class AzureAppServiceManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-am-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;
         const appServicePlan = new service_plan_1.ServicePlan(scope, `${id}-am`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             resourceGroupName: resourceGroup.name,
             tags: props.tags ?? {
                 environment: scope.props.stage,

package/dist/src/lib/azure/services/application-insights/main.js

@@ -33,9 +33,7 @@ class AzureApplicationInsightsManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-am-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;

package/dist/src/lib/azure/services/cosmosdb/main.js

@@ -35,15 +35,13 @@ class AzureCosmosDbManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-ca-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;
         const cosmosdbAccount = new cosmosdb_account_1.CosmosdbAccount(scope, `${id}-ca`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             location: resourceGroup.location,
             resourceGroupName: resourceGroup.name,
             tags: props.tags ?? {
@@ -66,15 +64,13 @@ class AzureCosmosDbManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-cd-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;
         const cosmosdbDatatbase = new cosmosdb_sql_database_1.CosmosdbSqlDatabase(scope, `${id}-cd`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             resourceGroupName: resourceGroup.name,
         });
         (0, utils_1.createAzureTfOutput)(`${id}-cosmosdbDatatbasetName`, scope, cosmosdbDatatbase.name);
@@ -101,7 +97,7 @@ class AzureCosmosDbManager {
             throw `Resource group undefined for ${id}`;
         const cosmosdbContainer = new cosmosdb_sql_container_1.CosmosdbSqlContainer(scope, `${id}-cc`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             resourceGroupName: resourceGroup.name,
         });
         (0, utils_1.createAzureTfOutput)(`${id}-cosmosdbContainertName`, scope, cosmosdbContainer.name);

package/dist/src/lib/azure/services/dns/main.js

@@ -36,15 +36,13 @@ class AzureDnsManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-am-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;
         const dnsZone = new dns_zone_1.DnsZone(scope, `${id}-dz`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             resourceGroupName: resourceGroup.name,
             tags: props.tags ?? {
                 environment: scope.props.stage,
@@ -71,7 +69,7 @@ class AzureDnsManager {
         });
         const dnsARecord = new dns_a_record_1.DnsARecord(scope, `${id}-da`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             resourceGroupName: dnsZone.resourceGroupName,
             zoneName: dnsZone.name,
             tags: props.tags ?? {
@@ -99,7 +97,7 @@ class AzureDnsManager {
         });
         const dnsCnameRecord = new dns_cname_record_1.DnsCnameRecord(scope, `${id}-dc`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             resourceGroupName: dnsZone.resourceGroupName,
             zoneName: dnsZone.name,
             tags: props.tags ?? {

package/dist/src/lib/azure/services/eventgrid/main.js

@@ -35,9 +35,7 @@ class AzureEventgridManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-et-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;
@@ -67,15 +65,13 @@ class AzureEventgridManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-et-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;
         const eventgridTopic = new data_azurerm_eventgrid_topic_1.DataAzurermEventgridTopic(scope, `${id}-et`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             resourceGroupName: resourceGroup.name,
         });
         (0, utils_1.createAzureTfOutput)(`${id}-eventgridTopicName`, scope, eventgridTopic.name);
@@ -96,7 +92,7 @@ class AzureEventgridManager {
             throw `Props undefined for ${id}`;
         const eventgridSubscription = new eventgrid_event_subscription_1.EventgridEventSubscription(scope, `${id}-es`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             eventDeliverySchema: props.eventDeliverySchema || 'CloudEventSchemaV1_0',
             advancedFilteringOnArraysEnabled: props.advancedFilteringOnArraysEnabled || true,
         });

package/dist/src/lib/azure/services/function/main.js

@@ -36,15 +36,13 @@ class AzureFunctionManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-fa-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;
         const functionApp = new linux_function_app_1.LinuxFunctionApp(scope, `${id}-fa`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             resourceGroupName: resourceGroup.name,
             tags: props.tags ?? {
                 environment: scope.props.stage,
@@ -67,7 +65,7 @@ class AzureFunctionManager {
             throw `Props undefined for ${id}`;
         const functionAppFunction = new function_app_function_1.FunctionAppFunction(scope, `${id}-fc`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             configJson: JSON.stringify(props.configJson || {}),
         });
         (0, utils_1.createAzureTfOutput)(`${id}-functionName`, scope, functionAppFunction.name);
@@ -85,15 +83,13 @@ class AzureFunctionManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-fa-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;
         const functionApp = new resource_1.Resource(scope, `${id}-fa`, {
             type: 'Microsoft.Web/sites@2024-04-01',
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             location: resourceGroup.location,
             parentId: resourceGroup.id,
             body: {

package/dist/src/lib/azure/services/key-vault/main.js

@@ -33,15 +33,13 @@ class AzureKeyVaultManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-kv-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;
         const keyVault = new key_vault_1.KeyVault(scope, `${id}-kv`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             location: resourceGroup.location,
             resourceGroupName: resourceGroup.name,
             skuName: props.skuName ?? 'standard',

package/dist/src/lib/azure/services/log-analytics-workspace/main.js

@@ -33,15 +33,13 @@ class AzureLogAnalyticsWorkspaceManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-lw-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;
         const logAnalyticsWorkspace = new log_analytics_workspace_1.LogAnalyticsWorkspace(scope, `${id}-lw`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             location: resourceGroup.location,
             resourceGroupName: resourceGroup.name,
             tags: props.tags ?? {

package/dist/src/lib/azure/services/servicebus/main.js

@@ -36,15 +36,13 @@ class AzureServicebusManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-sn-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;
         const servicebusNamespace = new servicebus_namespace_1.ServicebusNamespace(scope, `${id}-sn`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             resourceGroupName: resourceGroup.name,
             location: resourceGroup.location,
             identity: {
@@ -72,7 +70,7 @@ class AzureServicebusManager {
             throw `Props undefined for ${id}`;
         const servicebusTopic = new servicebus_topic_1.ServicebusTopic(scope, `${id}-st`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             namespaceId: props.namespaceId,
         });
         (0, utils_1.createAzureTfOutput)(`${id}-servicebusTopicName`, scope, servicebusTopic.name);
@@ -92,7 +90,7 @@ class AzureServicebusManager {
             throw `Props undefined for ${id}`;
         const servicebusQueue = new servicebus_queue_1.ServicebusQueue(scope, `${id}-sq`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             namespaceId: props.namespaceId,
         });
         (0, utils_1.createAzureTfOutput)(`${id}-servicebusQueueName`, scope, servicebusQueue.name);
@@ -112,7 +110,7 @@ class AzureServicebusManager {
             throw `Props undefined for ${id}`;
         const servicebusSubscription = new servicebus_subscription_1.ServicebusSubscription(scope, `${id}-ss`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             maxDeliveryCount: props.maxDeliveryCount || 1,
         });
         (0, utils_1.createAzureTfOutput)(`${id}-servicebusSubscriptionName`, scope, servicebusSubscription.name);

package/dist/src/lib/azure/services/storage/main.js

@@ -37,9 +37,7 @@ class AzureStorageManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-sc-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;
@@ -70,7 +68,7 @@ class AzureStorageManager {
             throw `Props undefined for ${id}`;
         const storageContainer = new storage_container_1.StorageContainer(scope, `${id}-sc`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
         });
         (0, utils_1.createAzureTfOutput)(`${id}-storageContainerName`, scope, storageContainer.name);
         (0, utils_1.createAzureTfOutput)(`${id}-storageContainerFriendlyUniqueId`, scope, storageContainer.friendlyUniqueId);
@@ -88,9 +86,7 @@ class AzureStorageManager {
         if (!props)
             throw `Props undefined for ${id}`;
         const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-sb-rg`, {
-            name: scope.props.resourceGroupName
-                ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-                : `${props.resourceGroupName}`,
+            name: scope.resourceNameFormatter.format(scope.props.resourceGroupName || props.resourceGroupName, scope.props.resourceNameOptions?.resourceGroup),
         });
         if (!resourceGroup)
             throw `Resource group undefined for ${id}`;
@@ -105,7 +101,7 @@ class AzureStorageManager {
         });
         const storageBlob = new storage_blob_1.StorageBlob(scope, `${id}-sb`, {
             ...props,
-            name: `${props.name}-${scope.props.stage}`,
+            name: scope.resourceNameFormatter.format(props.name),
             storageAccountName: storageAccount.name,
             storageContainerName: storageContainer.name,
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils",
-  "version": "9.40.0",
+  "version": "9.41.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {

package/src/lib/azure/common/construct.ts

@@ -21,6 +21,7 @@ import {
 } from '../services'
 import { CommonAzureStackProps } from './types'
 import { AzureRemoteBackend } from './constants'
+import { AzureResourceNameFormatter } from './resource-name-formatter'
 
 export class CommonAzureConstruct extends TerraformStack {
   declare props: CommonAzureStackProps
@@ -37,6 +38,7 @@ export class CommonAzureConstruct extends TerraformStack {
   keyVaultManager: AzureKeyVaultManager
   logAnalyticsWorkspaceManager: AzureLogAnalyticsWorkspaceManager
   resourceGroupManager: AzureResourceGroupManager
+  resourceNameFormatter: AzureResourceNameFormatter
   servicebusManager: AzureServicebusManager
   storageManager: AzureStorageManager
   tenantId: string
@@ -57,6 +59,7 @@ export class CommonAzureConstruct extends TerraformStack {
     this.keyVaultManager = new AzureKeyVaultManager()
     this.logAnalyticsWorkspaceManager = new AzureLogAnalyticsWorkspaceManager()
     this.resourceGroupManager = new AzureResourceGroupManager()
+    this.resourceNameFormatter = new AzureResourceNameFormatter(this, `${id}-rnf`, props)
     this.servicebusManager = new AzureServicebusManager()
     this.storageManager = new AzureStorageManager()
 

package/src/lib/azure/common/resource-name-formatter.ts

@@ -0,0 +1,38 @@
+import { Construct } from 'constructs'
+import { AzureResourceNameFormatterProps } from './types'
+import { CommonAzureStackProps } from './types'
+
+export class AzureResourceNameFormatter extends Construct {
+  props: CommonAzureStackProps
+
+  constructor(parent: Construct, id: string, props: CommonAzureStackProps) {
+    super(parent, id)
+    this.props = props
+  }
+
+  /**
+   * @summary Helper method to format azure resource name based on the provided options
+   * @param resourceName The azure resource name to format
+   * @param options Options to control the formatting of the resource name
+   * @returns The formatted Azure-compliant resource name
+   */
+  public format(resourceName: string, options?: AzureResourceNameFormatterProps) {
+    const azureResourceNameElements = []
+
+    if (!options?.exclude) {
+      azureResourceNameElements.push(options?.globalPrefix ? this.props.globalPrefix : undefined)
+      azureResourceNameElements.push(options?.prefix ?? this.props.resourcePrefix)
+    }
+
+    azureResourceNameElements.push(resourceName)
+
+    if (!options?.exclude) {
+      azureResourceNameElements.push(options?.suffix ?? this.props.resourceSuffix)
+      azureResourceNameElements.push(options?.globalSuffix ? this.props.globalSuffix : undefined)
+    }
+
+    azureResourceNameElements.push(this.props.stage)
+
+    return azureResourceNameElements.filter(Boolean).join('-')
+  }
+}

package/src/lib/azure/common/types.ts

@@ -8,8 +8,21 @@ import { AzurermBackendConfig } from 'cdktf'
 export interface CommonAzureStackProps extends BaseProps, AzurermProviderConfig {
   resourceGroupName?: string
   remoteBackend?: AzureRemoteBackendProps
+  globalPrefix?: string
+  globalSuffix?: string
+  resourcePrefix?: string
+  resourceSuffix?: string
+  resourceNameOptions?: { [key: string]: AzureResourceNameFormatterProps }
 }
 
 export interface AzureRemoteBackendProps extends AzurermBackendConfig {
   type: AzureRemoteBackend
 }
+
+export interface AzureResourceNameFormatterProps {
+  exclude?: boolean
+  globalPrefix?: boolean
+  globalSuffix?: boolean
+  prefix?: string
+  suffix?: string
+}

package/src/lib/azure/services/api-management/main.ts

@@ -51,9 +51,10 @@ export class AzureApiManagementManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-am-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`

package/src/lib/azure/services/app-configuration/main.ts

@@ -33,9 +33,10 @@ export class AzureAppConfigurationManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-am-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`

package/src/lib/azure/services/app-service/main.ts

@@ -33,16 +33,17 @@ export class AzureAppServiceManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-am-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`
 
     const appServicePlan = new ServicePlan(scope, `${id}-am`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       resourceGroupName: resourceGroup.name,
       tags: props.tags ?? {
         environment: scope.props.stage,

package/src/lib/azure/services/application-insights/main.ts

@@ -33,9 +33,10 @@ export class AzureApplicationInsightsManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-am-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`

package/src/lib/azure/services/cosmosdb/main.ts

@@ -35,16 +35,17 @@ export class AzureCosmosDbManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-ca-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`
 
     const cosmosdbAccount = new CosmosdbAccount(scope, `${id}-ca`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       location: resourceGroup.location,
       resourceGroupName: resourceGroup.name,
       tags: props.tags ?? {
@@ -70,16 +71,17 @@ export class AzureCosmosDbManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-cd-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`
 
     const cosmosdbDatatbase = new CosmosdbSqlDatabase(scope, `${id}-cd`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       resourceGroupName: resourceGroup.name,
     })
 
@@ -110,7 +112,7 @@ export class AzureCosmosDbManager {
 
     const cosmosdbContainer = new CosmosdbSqlContainer(scope, `${id}-cc`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       resourceGroupName: resourceGroup.name,
     })
 

package/src/lib/azure/services/dns/main.ts

@@ -36,16 +36,17 @@ export class AzureDnsManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-am-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`
 
     const dnsZone = new DnsZone(scope, `${id}-dz`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       resourceGroupName: resourceGroup.name,
       tags: props.tags ?? {
         environment: scope.props.stage,
@@ -76,7 +77,7 @@ export class AzureDnsManager {
 
     const dnsARecord = new DnsARecord(scope, `${id}-da`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       resourceGroupName: dnsZone.resourceGroupName,
       zoneName: dnsZone.name,
       tags: props.tags ?? {
@@ -108,7 +109,7 @@ export class AzureDnsManager {
 
     const dnsCnameRecord = new DnsCnameRecord(scope, `${id}-dc`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       resourceGroupName: dnsZone.resourceGroupName,
       zoneName: dnsZone.name,
       tags: props.tags ?? {

package/src/lib/azure/services/eventgrid/main.ts

@@ -38,9 +38,10 @@ export class AzureEventgridManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-et-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`
@@ -74,16 +75,17 @@ export class AzureEventgridManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-et-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`
 
     const eventgridTopic = new DataAzurermEventgridTopic(scope, `${id}-et`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       resourceGroupName: resourceGroup.name,
     })
 
@@ -107,7 +109,7 @@ export class AzureEventgridManager {
 
     const eventgridSubscription = new EventgridEventSubscription(scope, `${id}-es`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       eventDeliverySchema: props.eventDeliverySchema || 'CloudEventSchemaV1_0',
       advancedFilteringOnArraysEnabled: props.advancedFilteringOnArraysEnabled || true,
     })

package/src/lib/azure/services/function/main.ts

@@ -36,16 +36,17 @@ export class AzureFunctionManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-fa-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`
 
     const functionApp = new LinuxFunctionApp(scope, `${id}-fa`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       resourceGroupName: resourceGroup.name,
       tags: props.tags ?? {
         environment: scope.props.stage,
@@ -71,7 +72,7 @@ export class AzureFunctionManager {
 
     const functionAppFunction = new FunctionAppFunction(scope, `${id}-fc`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       configJson: JSON.stringify(props.configJson || {}),
     })
 
@@ -96,16 +97,17 @@ export class AzureFunctionManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-fa-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`
 
     const functionApp = new Resource(scope, `${id}-fa`, {
       type: 'Microsoft.Web/sites@2024-04-01',
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       location: resourceGroup.location,
       parentId: resourceGroup.id,
 

package/src/lib/azure/services/key-vault/main.ts

@@ -33,16 +33,17 @@ export class AzureKeyVaultManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-kv-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`
 
     const keyVault = new KeyVault(scope, `${id}-kv`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       location: resourceGroup.location,
       resourceGroupName: resourceGroup.name,
       skuName: props.skuName ?? 'standard',

package/src/lib/azure/services/log-analytics-workspace/main.ts

@@ -33,16 +33,17 @@ export class AzureLogAnalyticsWorkspaceManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-lw-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`
 
     const logAnalyticsWorkspace = new LogAnalyticsWorkspace(scope, `${id}-lw`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       location: resourceGroup.location,
       resourceGroupName: resourceGroup.name,
       tags: props.tags ?? {

package/src/lib/azure/services/servicebus/main.ts

@@ -41,16 +41,17 @@ export class AzureServicebusManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-sn-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`
 
     const servicebusNamespace = new ServicebusNamespace(scope, `${id}-sn`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       resourceGroupName: resourceGroup.name,
       location: resourceGroup.location,
       identity: {
@@ -81,7 +82,7 @@ export class AzureServicebusManager {
 
     const servicebusTopic = new ServicebusTopic(scope, `${id}-st`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       namespaceId: props.namespaceId,
     })
 
@@ -104,7 +105,7 @@ export class AzureServicebusManager {
 
     const servicebusQueue = new ServicebusQueue(scope, `${id}-sq`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       namespaceId: props.namespaceId,
     })
 
@@ -127,7 +128,7 @@ export class AzureServicebusManager {
 
     const servicebusSubscription = new ServicebusSubscription(scope, `${id}-ss`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       maxDeliveryCount: props.maxDeliveryCount || 1,
     })
 

package/src/lib/azure/services/storage/main.ts

@@ -37,9 +37,10 @@ export class AzureStorageManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-sc-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`
@@ -74,7 +75,7 @@ export class AzureStorageManager {
 
     const storageContainer = new StorageContainer(scope, `${id}-sc`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
     })
 
     createAzureTfOutput(`${id}-storageContainerName`, scope, storageContainer.name)
@@ -95,9 +96,10 @@ export class AzureStorageManager {
     if (!props) throw `Props undefined for ${id}`
 
     const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-sb-rg`, {
-      name: scope.props.resourceGroupName
-        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
-        : `${props.resourceGroupName}`,
+      name: scope.resourceNameFormatter.format(
+        scope.props.resourceGroupName || props.resourceGroupName,
+        scope.props.resourceNameOptions?.resourceGroup
+      ),
     })
 
     if (!resourceGroup) throw `Resource group undefined for ${id}`
@@ -115,7 +117,7 @@ export class AzureStorageManager {
 
     const storageBlob = new StorageBlob(scope, `${id}-sb`, {
       ...props,
-      name: `${props.name}-${scope.props.stage}`,
+      name: scope.resourceNameFormatter.format(props.name),
       storageAccountName: storageAccount.name,
       storageContainerName: storageContainer.name,
     })