@gradientedge/cdk-utils 9.39.2 → 9.41.0

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

@@ -1,4 +1,8 @@
 import { DataAzurermResourceGroup } from '@cdktf/provider-azurerm/lib/data-azurerm-resource-group'
+import {
+  DataAzurermEventgridTopic,
+  DataAzurermEventgridTopicConfig,
+} from '@cdktf/provider-azurerm/lib/data-azurerm-eventgrid-topic'
 import { EventgridTopic } from '@cdktf/provider-azurerm/lib/eventgrid-topic'
 import { EventgridEventSubscription } from '@cdktf/provider-azurerm/lib/eventgrid-event-subscription'
 import { CommonAzureConstruct } from '../../common'
@@ -34,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}`
@@ -54,6 +59,40 @@ export class AzureEventgridManager {
     createAzureTfOutput(`${id}-eventgridTopicName`, scope, eventgridTopic.name)
     createAzureTfOutput(`${id}-eventgridTopicFriendlyUniqueId`, scope, eventgridTopic.friendlyUniqueId)
     createAzureTfOutput(`${id}-eventgridTopicId`, scope, eventgridTopic.id)
+    createAzureTfOutput(`${id}-eventgridTopicEndpoint`, scope, eventgridTopic.endpoint)
+
+    return eventgridTopic
+  }
+
+  /**
+   * @summary Method to resolve an existing eventgrid topic
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props eventgrid topic properties
+   * @see [CDKTF Eventgrid Topic Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/eventgridTopic.typescript.md}
+   */
+  public resolveEventgridTopic(id: string, scope: CommonAzureConstruct, props: DataAzurermEventgridTopicConfig) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-et-rg`, {
+      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: scope.resourceNameFormatter.format(props.name),
+      resourceGroupName: resourceGroup.name,
+    })
+
+    createAzureTfOutput(`${id}-eventgridTopicName`, scope, eventgridTopic.name)
+    createAzureTfOutput(`${id}-eventgridTopicFriendlyUniqueId`, scope, eventgridTopic.friendlyUniqueId)
+    createAzureTfOutput(`${id}-eventgridTopicId`, scope, eventgridTopic.id)
+    createAzureTfOutput(`${id}-eventgridTopicEndpoint`, scope, eventgridTopic.endpoint)
 
     return eventgridTopic
   }
@@ -70,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/eventgrid/types.ts

@@ -1,5 +1,8 @@
 import { EventgridTopicConfig } from '@cdktf/provider-azurerm/lib/eventgrid-topic'
 import { EventgridEventSubscriptionConfig } from '@cdktf/provider-azurerm/lib/eventgrid-event-subscription'
 
-export interface EventgridTopicProps extends EventgridTopicConfig {}
+export interface EventgridTopicProps extends Omit<EventgridTopicConfig, 'name'> {
+  name?: string | undefined
+}
+
 export interface EventgridEventSubscriptionProps extends EventgridEventSubscriptionConfig {}

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

@@ -3,9 +3,11 @@ export * from './app-configuration'
 export * from './app-service'
 export * from './application-insights'
 export * from './cosmosdb'
+export * from './dns'
 export * from './eventgrid'
 export * from './function'
 export * from './key-vault'
+export * from './log-analytics-workspace'
 export * from './resource-group'
 export * from './servicebus'
 export * from './storage'

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

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

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

@@ -0,0 +1,60 @@
+import { DataAzurermResourceGroup } from '@cdktf/provider-azurerm/lib/data-azurerm-resource-group'
+import { LogAnalyticsWorkspace } from '@cdktf/provider-azurerm/lib/log-analytics-workspace'
+import { CommonAzureConstruct } from '../../common'
+import { createAzureTfOutput } from '../../utils'
+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 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}
+   */
+  public createLogAnalyticsWorkspace(id: string, scope: CommonAzureConstruct, props: LogAnalyticsWorkspaceProps) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const resourceGroup = new 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 LogAnalyticsWorkspace(scope, `${id}-lw`, {
+      ...props,
+      name: scope.resourceNameFormatter.format(props.name),
+      location: resourceGroup.location,
+      resourceGroupName: resourceGroup.name,
+      tags: props.tags ?? {
+        environment: scope.props.stage,
+      },
+    })
+
+    createAzureTfOutput(`${id}-logAnalyticsWorkspaceName`, scope, logAnalyticsWorkspace.name)
+    createAzureTfOutput(`${id}-logAnalyticsWorkspaceFriendlyUniqueId`, scope, logAnalyticsWorkspace.friendlyUniqueId)
+    createAzureTfOutput(`${id}-logAnalyticsWorkspaceId`, scope, logAnalyticsWorkspace.id)
+
+    return logAnalyticsWorkspace
+  }
+}

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

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

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,
     })