@gradientedge/cdk-utils 9.39.2 → 9.41.0

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/index.d.ts

@@ -0,0 +1,2 @@
+export * from './main';
+export * from './types';

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

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./main"), exports);
+__exportStar(require("./types"), exports);

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

@@ -0,0 +1,30 @@
+import { LogAnalyticsWorkspace } from '@cdktf/provider-azurerm/lib/log-analytics-workspace';
+import { CommonAzureConstruct } from '../../common';
+import { LogAnalyticsWorkspaceProps } from './types';
+/**
+ * @classdesc Provides operations on Azure Log Analytics Workspace
+ * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
+ * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
+ * @example
+ * ```
+ * import { CommonAzureConstruct, CommonAzureStackProps } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonAzureConstruct {
+ *   constructor(parent: Construct, id: string, props: CommonAzureStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.LogAnalyticWorkspaceManager.createLogAnalyticsWorkspace('MyLogAnalyticsWorkspace', this, props)
+ *   }
+ * }
+ * ```
+ */
+export declare class AzureLogAnalyticsWorkspaceManager {
+    /**
+     * @summary Method to create a new cosmosdb account
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props cosmosdb account properties
+     * @see [CDKTF CosmosDb Account Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/logAnalyticsWorkspace.typescript.md}
+     */
+    createLogAnalyticsWorkspace(id: string, scope: CommonAzureConstruct, props: LogAnalyticsWorkspaceProps): LogAnalyticsWorkspace;
+}

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

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AzureLogAnalyticsWorkspaceManager = void 0;
+const data_azurerm_resource_group_1 = require("@cdktf/provider-azurerm/lib/data-azurerm-resource-group");
+const log_analytics_workspace_1 = require("@cdktf/provider-azurerm/lib/log-analytics-workspace");
+const utils_1 = require("../../utils");
+/**
+ * @classdesc Provides operations on Azure Log Analytics Workspace
+ * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
+ * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
+ * @example
+ * ```
+ * import { CommonAzureConstruct, CommonAzureStackProps } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonAzureConstruct {
+ *   constructor(parent: Construct, id: string, props: CommonAzureStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.LogAnalyticWorkspaceManager.createLogAnalyticsWorkspace('MyLogAnalyticsWorkspace', this, props)
+ *   }
+ * }
+ * ```
+ */
+class AzureLogAnalyticsWorkspaceManager {
+    /**
+     * @summary Method to create a new cosmosdb account
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props cosmosdb account properties
+     * @see [CDKTF CosmosDb Account Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/logAnalyticsWorkspace.typescript.md}
+     */
+    createLogAnalyticsWorkspace(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const resourceGroup = new data_azurerm_resource_group_1.DataAzurermResourceGroup(scope, `${id}-lw-rg`, {
+            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: scope.resourceNameFormatter.format(props.name),
+            location: resourceGroup.location,
+            resourceGroupName: resourceGroup.name,
+            tags: props.tags ?? {
+                environment: scope.props.stage,
+            },
+        });
+        (0, utils_1.createAzureTfOutput)(`${id}-logAnalyticsWorkspaceName`, scope, logAnalyticsWorkspace.name);
+        (0, utils_1.createAzureTfOutput)(`${id}-logAnalyticsWorkspaceFriendlyUniqueId`, scope, logAnalyticsWorkspace.friendlyUniqueId);
+        (0, utils_1.createAzureTfOutput)(`${id}-logAnalyticsWorkspaceId`, scope, logAnalyticsWorkspace.id);
+        return logAnalyticsWorkspace;
+    }
+}
+exports.AzureLogAnalyticsWorkspaceManager = AzureLogAnalyticsWorkspaceManager;

package/dist/src/lib/azure/services/log-analytics-workspace/types.d.ts

@@ -0,0 +1,3 @@
+import { LogAnalyticsWorkspaceConfig } from '@cdktf/provider-azurerm/lib/log-analytics-workspace';
+export interface LogAnalyticsWorkspaceProps extends LogAnalyticsWorkspaceConfig {
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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.39.2",
+  "version": "9.41.0",
   "description": "Utilities for AWS CDK provisioning",
   "main": "dist/index.js",
   "engines": {

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

@@ -16,26 +16,32 @@ import {
   AzureCosmosDbManager,
   AzureServicebusManager,
   AzureEventgridManager,
+  AzureDnsManager,
+  AzureLogAnalyticsWorkspaceManager,
 } from '../services'
 import { CommonAzureStackProps } from './types'
 import { AzureRemoteBackend } from './constants'
+import { AzureResourceNameFormatter } from './resource-name-formatter'
 
 export class CommonAzureConstruct extends TerraformStack {
   declare props: CommonAzureStackProps
-  id: string
-  fullyQualifiedDomainName: string
-  tenantId: string
   apiManagementManager: AzureApiManagementManager
+  appConfigurationManager: AzureAppConfigurationManager
   appServiceManager: AzureAppServiceManager
   applicationInsightsManager: AzureApplicationInsightsManager
-  appConfigurationManager: AzureAppConfigurationManager
   cosmosDbManager: AzureCosmosDbManager
+  dnsManager: AzureDnsManager
+  eventgridManager: AzureEventgridManager
+  fullyQualifiedDomainName: string
   functiontManager: AzureFunctionManager
+  id: string
   keyVaultManager: AzureKeyVaultManager
+  logAnalyticsWorkspaceManager: AzureLogAnalyticsWorkspaceManager
   resourceGroupManager: AzureResourceGroupManager
-  storageManager: AzureStorageManager
+  resourceNameFormatter: AzureResourceNameFormatter
   servicebusManager: AzureServicebusManager
-  eventgridManager: AzureEventgridManager
+  storageManager: AzureStorageManager
+  tenantId: string
 
   constructor(scope: Construct, id: string, props: CommonAzureStackProps) {
     super(scope, id)
@@ -43,22 +49,26 @@ export class CommonAzureConstruct extends TerraformStack {
     this.id = id
 
     this.apiManagementManager = new AzureApiManagementManager()
+    this.appConfigurationManager = new AzureAppConfigurationManager()
     this.appServiceManager = new AzureAppServiceManager()
     this.applicationInsightsManager = new AzureApplicationInsightsManager()
-    this.appConfigurationManager = new AzureAppConfigurationManager()
     this.cosmosDbManager = new AzureCosmosDbManager()
+    this.dnsManager = new AzureDnsManager()
+    this.eventgridManager = new AzureEventgridManager()
     this.functiontManager = new AzureFunctionManager()
     this.keyVaultManager = new AzureKeyVaultManager()
+    this.logAnalyticsWorkspaceManager = new AzureLogAnalyticsWorkspaceManager()
     this.resourceGroupManager = new AzureResourceGroupManager()
-    this.storageManager = new AzureStorageManager()
+    this.resourceNameFormatter = new AzureResourceNameFormatter(this, `${id}-rnf`, props)
     this.servicebusManager = new AzureServicebusManager()
-    this.eventgridManager = new AzureEventgridManager()
+    this.storageManager = new AzureStorageManager()
 
     this.determineFullyQualifiedDomain()
     this.determineRemoteBackend()
     this.determineTenantId()
-    new AzurermProvider(this, `${this.id}-provider`, this.props)
+
     new AzapiProvider(this, `${this.id}-azapi-provider`, this.props)
+    new AzurermProvider(this, `${this.id}-provider`, this.props)
   }
 
   /**

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/api-management/types.ts

@@ -4,7 +4,9 @@ import { ApiManagementApiConfig } from '@cdktf/provider-azurerm/lib/api-manageme
 import { ApiManagementApiOperationConfig } from '@cdktf/provider-azurerm/lib/api-management-api-operation'
 import { ApiManagementApiOperationPolicyConfig } from '@cdktf/provider-azurerm/lib/api-management-api-operation-policy'
 
-export interface ApiManagementProps extends ApiManagementConfig {}
+export interface ApiManagementProps extends Omit<ApiManagementConfig, 'name'> {
+  name?: string | undefined
+}
 
 export interface ApiManagementBackendProps extends ApiManagementBackendConfig {}
 

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/index.ts

@@ -0,0 +1,2 @@
+export * from './main'
+export * from './types'

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

@@ -0,0 +1,126 @@
+import { DataAzurermResourceGroup } from '@cdktf/provider-azurerm/lib/data-azurerm-resource-group'
+import { DataAzurermDnsZone } from '@cdktf/provider-azurerm/lib/data-azurerm-dns-zone'
+import { DnsZone } from '@cdktf/provider-azurerm/lib/dns-zone'
+import { DnsARecord } from '@cdktf/provider-azurerm/lib/dns-a-record'
+import { DnsCnameRecord } from '@cdktf/provider-azurerm/lib/dns-cname-record'
+import { CommonAzureConstruct } from '../../common'
+import { createAzureTfOutput } from '../../utils'
+import { DnsZoneProps, DnsARecordProps, DnsCnameRecordProps } from './types'
+
+/**
+ * @classdesc Provides operations on Azure DNS
+ * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
+ * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
+ * @example
+ * ```
+ * import { CommonAzureConstruct, CommonAzureStackProps } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonAzureConstruct {
+ *   constructor(parent: Construct, id: string, props: CommonAzureStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.dnsManager.createAppService('MyDnsZone', this, props)
+ *   }
+ * }
+ * ```
+ */
+export class AzureDnsManager {
+  /**
+   * @summary Method to create a new DNS Zone
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props dns zone properties
+   * @see [CDKTF DNS Zone Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/DnsZone.typescript.md}
+   */
+  public createDnsZone(id: string, scope: CommonAzureConstruct, props: DnsZoneProps) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-am-rg`, {
+      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: scope.resourceNameFormatter.format(props.name),
+      resourceGroupName: resourceGroup.name,
+      tags: props.tags ?? {
+        environment: scope.props.stage,
+      },
+    })
+
+    createAzureTfOutput(`${id}-dnsZoneName`, scope, dnsZone.name)
+    createAzureTfOutput(`${id}-dnsZoneFriendlyUniqueId`, scope, dnsZone.friendlyUniqueId)
+    createAzureTfOutput(`${id}-dnsZoneId`, scope, dnsZone.id)
+
+    return dnsZone
+  }
+
+  /**
+   * @summary Method to create a new DNS A Record
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props dns a record properties
+   * @see [CDKTF DNS A Record Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/DnsARecord.typescript.md}
+   */
+  public createDnsARecord(id: string, scope: CommonAzureConstruct, props: DnsARecordProps) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const dnsZone = new DataAzurermDnsZone(scope, `${id}-da-dz`, {
+      name: props.zoneName,
+      resourceGroupName: props.resourceGroupName,
+    })
+
+    const dnsARecord = new DnsARecord(scope, `${id}-da`, {
+      ...props,
+      name: scope.resourceNameFormatter.format(props.name),
+      resourceGroupName: dnsZone.resourceGroupName,
+      zoneName: dnsZone.name,
+      tags: props.tags ?? {
+        environment: scope.props.stage,
+      },
+    })
+
+    createAzureTfOutput(`${id}-dnsARecordName`, scope, dnsARecord.name)
+    createAzureTfOutput(`${id}-dnsARecordFriendlyUniqueId`, scope, dnsARecord.friendlyUniqueId)
+    createAzureTfOutput(`${id}-dnsARecordId`, scope, dnsARecord.id)
+
+    return dnsARecord
+  }
+
+  /**
+   * @summary Method to create a new DNS CNAME Record
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props dns cname record properties
+   * @see [CDKTF DNS CNAME Record Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/DnsCnameRecord.typescript.md}
+   */
+  public createDnsCnameRecord(id: string, scope: CommonAzureConstruct, props: DnsCnameRecordProps) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const dnsZone = new DataAzurermDnsZone(scope, `${id}-dc-dz`, {
+      name: props.zoneName,
+      resourceGroupName: props.resourceGroupName,
+    })
+
+    const dnsCnameRecord = new DnsCnameRecord(scope, `${id}-dc`, {
+      ...props,
+      name: scope.resourceNameFormatter.format(props.name),
+      resourceGroupName: dnsZone.resourceGroupName,
+      zoneName: dnsZone.name,
+      tags: props.tags ?? {
+        environment: scope.props.stage,
+      },
+    })
+
+    createAzureTfOutput(`${id}-dnsCnameRecordName`, scope, dnsCnameRecord.name)
+    createAzureTfOutput(`${id}-dnsCnameRecordFriendlyUniqueId`, scope, dnsCnameRecord.friendlyUniqueId)
+    createAzureTfOutput(`${id}-dnsCnameRecordId`, scope, dnsCnameRecord.id)
+
+    return dnsCnameRecord
+  }
+}

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

@@ -0,0 +1,7 @@
+import { DnsZoneConfig } from '@cdktf/provider-azurerm/lib/dns-zone'
+import { DnsARecordConfig } from '@cdktf/provider-azurerm/lib/dns-a-record'
+import { DnsCnameRecordConfig } from '@cdktf/provider-azurerm/lib/dns-cname-record'
+
+export interface DnsZoneProps extends DnsZoneConfig {}
+export interface DnsARecordProps extends DnsARecordConfig {}
+export interface DnsCnameRecordProps extends DnsCnameRecordConfig {}