@gradientedge/cdk-utils 9.31.0 → 9.32.0

package/dist/src/lib/azure/services/resource-group/main.d.ts

@@ -0,0 +1,30 @@
+import { ResourceGroup } from '@cdktf/provider-azurerm/lib/resource-group';
+import { CommonAzureConstruct } from '../../common';
+import { ResourceGroupProps } from './types';
+/**
+ * @classdesc Provides operations on Azure Resource Group
+ * - 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.resourceGroupManager.createResourceGroup('MyResourceGroup', this, props)
+ *   }
+ * }
+ * ```
+ */
+export declare class AzureResourceGroupManager {
+    /**
+     * @summary Method to create a new resource group
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props resource group properties
+     * @see [CDKTF Resource Group Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/resourceGroup.typescript.md}
+     */
+    createResourceGroup(id: string, scope: CommonAzureConstruct, props: ResourceGroupProps): ResourceGroup;
+}

package/dist/src/lib/azure/services/resource-group/main.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AzureResourceGroupManager = void 0;
+const resource_group_1 = require("@cdktf/provider-azurerm/lib/resource-group");
+const utils_1 = require("../../utils");
+/**
+ * @classdesc Provides operations on Azure Resource Group
+ * - 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.resourceGroupManager.createResourceGroup('MyResourceGroup', this, props)
+ *   }
+ * }
+ * ```
+ */
+class AzureResourceGroupManager {
+    /**
+     * @summary Method to create a new resource group
+     * @param id scoped id of the resource
+     * @param scope scope in which this resource is defined
+     * @param props resource group properties
+     * @see [CDKTF Resource Group Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/resourceGroup.typescript.md}
+     */
+    createResourceGroup(id, scope, props) {
+        if (!props)
+            throw `Props undefined for ${id}`;
+        const resourceGroup = new resource_group_1.ResourceGroup(scope, `${id}-rg`, {
+            ...props,
+            name: props.name,
+            location: props.location,
+            tags: props.tags ?? {
+                environment: scope.props.stage,
+            },
+        });
+        (0, utils_1.createAzureTfOutput)(`${id}-resourceGroupName`, scope, resourceGroup.name);
+        (0, utils_1.createAzureTfOutput)(`${id}-resourceGroupFriendlyUniqueId`, scope, resourceGroup.friendlyUniqueId);
+        (0, utils_1.createAzureTfOutput)(`${id}-resourceGroupId`, scope, resourceGroup.id);
+        return resourceGroup;
+    }
+}
+exports.AzureResourceGroupManager = AzureResourceGroupManager;

package/dist/src/lib/azure/services/resource-group/types.d.ts

@@ -0,0 +1,3 @@
+import { ResourceGroupConfig } from '@cdktf/provider-azurerm/lib/resource-group';
+export interface ResourceGroupProps extends ResourceGroupConfig {
+}

package/dist/src/lib/azure/services/resource-group/types.js

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

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

@@ -1,3 +1,6 @@
+import { StorageAccount } from '@cdktf/provider-azurerm/lib/storage-account';
+import { StorageBlob } from '@cdktf/provider-azurerm/lib/storage-blob';
+import { StorageContainer } from '@cdktf/provider-azurerm/lib/storage-container';
 import { CommonAzureConstruct } from '../../common';
 import { StorageAccountProps, StorageBlobProps, StorageContainerProps } from './types';
 /**
@@ -25,7 +28,7 @@ export declare class AzureStorageManager {
      * @param props storage account properties
      * @see [CDKTF Storage Account Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/storageAccount.typescript.md}
      */
-    createStorageAccount(id: string, scope: CommonAzureConstruct, props: StorageAccountProps): void;
+    createStorageAccount(id: string, scope: CommonAzureConstruct, props: StorageAccountProps): StorageAccount;
     /**
      * @summary Method to create a new storage container
      * @param id scoped id of the resource
@@ -33,7 +36,7 @@ export declare class AzureStorageManager {
      * @param props storage container properties
      * @see [CDKTF Storage Container Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/storageContainer.typescript.md}
      */
-    createStorageContainer(id: string, scope: CommonAzureConstruct, props: StorageContainerProps): void;
+    createStorageContainer(id: string, scope: CommonAzureConstruct, props: StorageContainerProps): StorageContainer;
     /**
      * @summary Method to create a new storage blob
      * @param id scoped id of the resource
@@ -41,5 +44,5 @@ export declare class AzureStorageManager {
      * @param props storage blob properties
      * @see [CDKTF Storage Blob Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/storageBlob.typescript.md}
      */
-    createStorageBlob(id: string, scope: CommonAzureConstruct, props: StorageBlobProps): void;
+    createStorageBlob(id: string, scope: CommonAzureConstruct, props: StorageBlobProps): StorageBlob;
 }

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

@@ -56,6 +56,7 @@ class AzureStorageManager {
         (0, utils_1.createAzureTfOutput)(`${id}-storageAccountName`, scope, storageAccount.name);
         (0, utils_1.createAzureTfOutput)(`${id}-storageAccountFriendlyUniqueId`, scope, storageAccount.friendlyUniqueId);
         (0, utils_1.createAzureTfOutput)(`${id}-storageAccountId`, scope, storageAccount.id);
+        return storageAccount;
     }
     /**
      * @summary Method to create a new storage container
@@ -86,6 +87,7 @@ class AzureStorageManager {
         (0, utils_1.createAzureTfOutput)(`${id}-storageContainerName`, scope, storageContainer.name);
         (0, utils_1.createAzureTfOutput)(`${id}-storageContainerFriendlyUniqueId`, scope, storageContainer.friendlyUniqueId);
         (0, utils_1.createAzureTfOutput)(`${id}-storageContainerId`, scope, storageContainer.id);
+        return storageContainer;
     }
     /**
      * @summary Method to create a new storage blob
@@ -121,6 +123,7 @@ class AzureStorageManager {
         (0, utils_1.createAzureTfOutput)(`${id}-storageBlobName`, scope, storageBlob.name);
         (0, utils_1.createAzureTfOutput)(`${id}-storageBlobFriendlyUniqueId`, scope, storageBlob.friendlyUniqueId);
         (0, utils_1.createAzureTfOutput)(`${id}-storageBlobId`, scope, storageBlob.id);
+        return storageBlob;
     }
 }
 exports.AzureStorageManager = AzureStorageManager;

package/package.json

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

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

@@ -0,0 +1,4 @@
+export enum AzureRemoteBackend {
+  local = 'local',
+  azurerm = 'azurerm',
+}

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

@@ -1,14 +1,27 @@
 import { AzurermProvider } from '@cdktf/provider-azurerm/lib/provider'
-import { TerraformStack } from 'cdktf'
+import { DataAzurermClientConfig } from '@cdktf/provider-azurerm/lib/data-azurerm-client-config'
+import { AzurermBackend, TerraformStack } from 'cdktf'
 import { Construct } from 'constructs'
 import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common'
-import { AzureStorageManager } from '../services'
+import {
+  AzureStorageManager,
+  AzureKeyVaultManager,
+  AzureApiManagementManager,
+  AzureFunctionManager,
+  AzureResourceGroupManager,
+} from '../services'
 import { CommonAzureStackProps } from './types'
+import { AzureRemoteBackend } from './constants'
 
 export class CommonAzureConstruct extends TerraformStack {
   declare props: CommonAzureStackProps
   id: string
   fullyQualifiedDomainName: string
+  tenantId: string
+  apiManagementtManager: AzureApiManagementManager
+  functiontManager: AzureFunctionManager
+  keyVaultManager: AzureKeyVaultManager
+  resourceGroupManager: AzureResourceGroupManager
   storageManager: AzureStorageManager
 
   constructor(scope: Construct, id: string, props: CommonAzureStackProps) {
@@ -16,9 +29,15 @@ export class CommonAzureConstruct extends TerraformStack {
     this.props = props
     this.id = id
 
+    this.apiManagementtManager = new AzureApiManagementManager()
+    this.functiontManager = new AzureFunctionManager()
+    this.keyVaultManager = new AzureKeyVaultManager()
+    this.resourceGroupManager = new AzureResourceGroupManager()
     this.storageManager = new AzureStorageManager()
 
     this.determineFullyQualifiedDomain()
+    this.determineRemoteBackend()
+    this.determineTenantId()
     new AzurermProvider(this, `${this.id}-provider`, this.props)
   }
 
@@ -31,6 +50,30 @@ export class CommonAzureConstruct extends TerraformStack {
       : this.props.domainName
   }
 
+  protected determineRemoteBackend() {
+    const debug = this.node.tryGetContext('debug')
+    switch (this.props.remoteBackend?.type) {
+      case AzureRemoteBackend.azurerm:
+        new AzurermBackend(this, {
+          storageAccountName: this.props.remoteBackend.storageAccountName,
+          containerName: this.props.remoteBackend.containerName,
+          key: `${this.id}`,
+          subscriptionId: this.props.subscriptionId,
+          resourceGroupName: this.props.remoteBackend.resourceGroupName,
+        })
+        break
+      case AzureRemoteBackend.local:
+        if (debug) console.debug(`Using local backend for ${this.id}`)
+        break
+      default:
+        break
+    }
+  }
+
+  protected determineTenantId() {
+    this.tenantId = new DataAzurermClientConfig(this, 'current', {}).tenantId
+  }
+
   /**
    * @summary Utility method to determine if the initialisation is in development (dev) stage
    * This is determined by the stage property injected via cdk context

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

@@ -1,3 +1,4 @@
+export * from './constants'
 export * from './construct'
 export * from './stack'
 export * from './types'

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

@@ -35,9 +35,6 @@ export class CommonAzureStack extends TerraformStack {
     this.determineStageContexts()
 
     this.props = this.determineConstructProps(props)
-
-    /* initialise the construct */
-    this.construct = new CommonAzureConstruct(this, 'cdk-utils', this.props)
   }
 
   /**
@@ -55,6 +52,7 @@ export class CommonAzureStack extends TerraformStack {
       skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
       stage: this.node.tryGetContext('stage'),
       subDomain: this.node.tryGetContext('subDomain'),
+      subscriptionId: this.node.tryGetContext('subscriptionId'),
     }
   }
 

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

@@ -1,8 +1,15 @@
 import { AzurermProviderConfig } from '@cdktf/provider-azurerm/lib/provider'
 import { BaseProps } from '../../common'
+import { AzureRemoteBackend } from './constants'
+import { AzurermBackendConfig } from 'cdktf'
 
 /**
  */
 export interface CommonAzureStackProps extends BaseProps, AzurermProviderConfig {
   resourceGroupName?: string
+  remoteBackend?: AzureRemoteBackendProps
+}
+
+export interface AzureRemoteBackendProps extends AzurermBackendConfig {
+  type: AzureRemoteBackend
 }

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

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

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

@@ -0,0 +1,58 @@
+import { DataAzurermResourceGroup } from '@cdktf/provider-azurerm/lib/data-azurerm-resource-group'
+import { ApiManagement } from '@cdktf/provider-azurerm/lib/api-management'
+import { CommonAzureConstruct } from '../../common'
+import { createAzureTfOutput } from '../../utils'
+import { ApiManagementProps } from './types'
+
+/**
+ * @classdesc Provides operations on Azure Api Management
+ * - 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.apiManagementManager.createApiManagement('MyApiManagement', this, props)
+ *   }
+ * }
+ * ```
+ */
+export class AzureApiManagementManager {
+  /**
+   * @summary Method to create a new api management
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props api management properties
+   * @see [CDKTF Api management Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/apiManagement.typescript.md}
+   */
+  public createApiManagement(id: string, scope: CommonAzureConstruct, props: ApiManagementProps) {
+    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}-${scope.props.stage}`,
+    })
+
+    if (!resourceGroup) throw `Resource group undefined for ${id}`
+
+    const apiManagement = new ApiManagement(scope, `${id}-am`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+      resourceGroupName: resourceGroup.name,
+      tags: props.tags ?? {
+        environment: scope.props.stage,
+      },
+    })
+
+    createAzureTfOutput(`${id}-apiManagementName`, scope, apiManagement.name)
+    createAzureTfOutput(`${id}-apiManagementFriendlyUniqueId`, scope, apiManagement.friendlyUniqueId)
+    createAzureTfOutput(`${id}-apiManagementId`, scope, apiManagement.id)
+
+    return apiManagement
+  }
+}

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

@@ -0,0 +1,3 @@
+import { ApiManagementConfig } from '@cdktf/provider-azurerm/lib/api-management'
+
+export interface ApiManagementProps extends ApiManagementConfig {}

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

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

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

@@ -0,0 +1,95 @@
+import { DataAzurermResourceGroup } from '@cdktf/provider-azurerm/lib/data-azurerm-resource-group'
+import { DataAzurermFunctionApp } from '@cdktf/provider-azurerm/lib/data-azurerm-function-app'
+import { FunctionApp } from '@cdktf/provider-azurerm/lib/function-app'
+import { FunctionAppFunction } from '@cdktf/provider-azurerm/lib/function-app-function'
+import { CommonAzureConstruct } from '../../common'
+import { createAzureTfOutput } from '../../utils'
+import { FunctionAppProps, FunctionProps } from './types'
+
+/**
+ * @classdesc Provides operations on Azure Functions
+ * - 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.functionManager.createFunctionApp('MyFunctionApp', this, props)
+ *   }
+ * }
+ * ```
+ */
+export class AzureFunctionManager {
+  /**
+   * @summary Method to create a new function app
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props function app properties
+   * @see [CDKTF Function App Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/functionApp.typescript.md}
+   */
+  public createFunctionApp(id: string, scope: CommonAzureConstruct, props: FunctionAppProps) {
+    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}-${scope.props.stage}`,
+    })
+
+    if (!resourceGroup) throw `Resource group undefined for ${id}`
+
+    const functionApp = new FunctionApp(scope, `${id}-fa`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+      resourceGroupName: resourceGroup.name,
+      tags: props.tags ?? {
+        environment: scope.props.stage,
+      },
+    })
+
+    createAzureTfOutput(`${id}-functionAppName`, scope, functionApp.name)
+    createAzureTfOutput(`${id}-functionAppFriendlyUniqueId`, scope, functionApp.friendlyUniqueId)
+    createAzureTfOutput(`${id}-functionAppId`, scope, functionApp.id)
+
+    return functionApp
+  }
+
+  /**
+   * @summary Method to create a new function
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props function properties
+   * @see [CDKTF Function Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/functionAppFunction.typescript.md}
+   */
+  public createFunction(id: string, scope: CommonAzureConstruct, props: FunctionProps) {
+    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}-${scope.props.stage}`,
+    })
+
+    if (!resourceGroup) throw `Resource group undefined for ${id}`
+
+    const storageAccount = new DataAzurermFunctionApp(scope, `${id}-sa`, {
+      name: `${props.functionAppName}-${scope.props.stage}`,
+      resourceGroupName: resourceGroup.name,
+    })
+
+    const functionAppFunction = new FunctionAppFunction(scope, `${id}-fc`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+    })
+
+    createAzureTfOutput(`${id}-functionName`, scope, functionAppFunction.name)
+    createAzureTfOutput(`${id}-functionFriendlyUniqueId`, scope, functionAppFunction.friendlyUniqueId)
+    createAzureTfOutput(`${id}-functionId`, scope, functionAppFunction.id)
+
+    return functionAppFunction
+  }
+}

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

@@ -0,0 +1,9 @@
+import { FunctionAppConfig } from '@cdktf/provider-azurerm/lib/function-app'
+import { FunctionAppFunctionConfig } from '@cdktf/provider-azurerm/lib/function-app-function'
+import { BaseAzureConfigProps } from '../../types'
+
+export interface FunctionAppProps extends FunctionAppConfig {}
+
+export interface FunctionProps extends BaseAzureConfigProps, FunctionAppFunctionConfig {
+  functionAppName: string
+}

package/src/lib/azure/services/index.ts

@@ -1 +1,5 @@
+export * from './api-management'
+export * from './function'
+export * from './key-vault'
+export * from './resource-group'
 export * from './storage'

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

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

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

@@ -0,0 +1,60 @@
+import { DataAzurermResourceGroup } from '@cdktf/provider-azurerm/lib/data-azurerm-resource-group'
+import { KeyVault } from '@cdktf/provider-azurerm/lib/key-vault'
+import { CommonAzureConstruct } from '../../common'
+import { createAzureTfOutput } from '../../utils'
+import { KeyVaultProps } from './types'
+
+/**
+ * @classdesc Provides operations on Azure Key Vault
+ * - 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.keyVaultManager.createKeyVault('MyKeyVault', this, props)
+ *   }
+ * }
+ * ```
+ */
+export class AzureKeyVaultManager {
+  /**
+   * @summary Method to create a new key vault
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props key vault properties
+   * @see [CDKTF Key Vault Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/keyVault.typescript.md}
+   */
+  public createKeyVault(id: string, scope: CommonAzureConstruct, props: KeyVaultProps) {
+    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}`,
+    })
+
+    if (!resourceGroup) throw `Resource group undefined for ${id}`
+
+    const keyVault = new KeyVault(scope, `${id}-kv`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+      location: resourceGroup.location,
+      resourceGroupName: resourceGroup.name,
+      skuName: props.skuName ?? 'standard',
+      tags: props.tags ?? {
+        environment: scope.props.stage,
+      },
+    })
+
+    createAzureTfOutput(`${id}-keyVaultName`, scope, keyVault.name)
+    createAzureTfOutput(`${id}-keyVaultFriendlyUniqueId`, scope, keyVault.friendlyUniqueId)
+    createAzureTfOutput(`${id}-keyVaultId`, scope, keyVault.id)
+
+    return keyVault
+  }
+}

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

@@ -0,0 +1,3 @@
+import { KeyVaultConfig } from '@cdktf/provider-azurerm/lib/key-vault'
+
+export interface KeyVaultProps extends KeyVaultConfig {}

package/src/lib/azure/services/resource-group/index.ts

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

package/src/lib/azure/services/resource-group/main.ts

@@ -0,0 +1,49 @@
+import { ResourceGroup } from '@cdktf/provider-azurerm/lib/resource-group'
+import { CommonAzureConstruct } from '../../common'
+import { createAzureTfOutput } from '../../utils'
+import { ResourceGroupProps } from './types'
+
+/**
+ * @classdesc Provides operations on Azure Resource Group
+ * - 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.resourceGroupManager.createResourceGroup('MyResourceGroup', this, props)
+ *   }
+ * }
+ * ```
+ */
+export class AzureResourceGroupManager {
+  /**
+   * @summary Method to create a new resource group
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props resource group properties
+   * @see [CDKTF Resource Group Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/resourceGroup.typescript.md}
+   */
+  public createResourceGroup(id: string, scope: CommonAzureConstruct, props: ResourceGroupProps) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const resourceGroup = new ResourceGroup(scope, `${id}-rg`, {
+      ...props,
+      name: props.name,
+      location: props.location,
+      tags: props.tags ?? {
+        environment: scope.props.stage,
+      },
+    })
+
+    createAzureTfOutput(`${id}-resourceGroupName`, scope, resourceGroup.name)
+    createAzureTfOutput(`${id}-resourceGroupFriendlyUniqueId`, scope, resourceGroup.friendlyUniqueId)
+    createAzureTfOutput(`${id}-resourceGroupId`, scope, resourceGroup.id)
+
+    return resourceGroup
+  }
+}

package/src/lib/azure/services/resource-group/types.ts

@@ -0,0 +1,3 @@
+import { ResourceGroupConfig } from '@cdktf/provider-azurerm/lib/resource-group'
+
+export interface ResourceGroupProps extends ResourceGroupConfig {}

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

@@ -58,6 +58,8 @@ export class AzureStorageManager {
     createAzureTfOutput(`${id}-storageAccountName`, scope, storageAccount.name)
     createAzureTfOutput(`${id}-storageAccountFriendlyUniqueId`, scope, storageAccount.friendlyUniqueId)
     createAzureTfOutput(`${id}-storageAccountId`, scope, storageAccount.id)
+
+    return storageAccount
   }
 
   /**
@@ -92,6 +94,8 @@ export class AzureStorageManager {
     createAzureTfOutput(`${id}-storageContainerName`, scope, storageContainer.name)
     createAzureTfOutput(`${id}-storageContainerFriendlyUniqueId`, scope, storageContainer.friendlyUniqueId)
     createAzureTfOutput(`${id}-storageContainerId`, scope, storageContainer.id)
+
+    return storageContainer
   }
 
   /**
@@ -132,5 +136,7 @@ export class AzureStorageManager {
     createAzureTfOutput(`${id}-storageBlobName`, scope, storageBlob.name)
     createAzureTfOutput(`${id}-storageBlobFriendlyUniqueId`, scope, storageBlob.friendlyUniqueId)
     createAzureTfOutput(`${id}-storageBlobId`, scope, storageBlob.id)
+
+    return storageBlob
   }
 }