@gradientedge/cdk-utils 10.6.0 → 10.8.0

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

@@ -1,5 +1,7 @@
+import { Deployment, DeploymentMode, Resource } from '@pulumi/azure-native/resources/index.js'
 import { ManagedServiceIdentityType, WebApp, WebAppFunction } from '@pulumi/azure-native/web/index.js'
-import { CommonAzureConstruct } from '../../common/index.js'
+import { ResourceOptions } from '@pulumi/pulumi'
+import { CommonAzureConstruct, CommonAzureStack } from '../../common/index.js'
 import { FunctionAppFlexConsumptionProps, FunctionAppProps, FunctionProps } from './types.js'
 
 /**
@@ -25,9 +27,15 @@ export class AzureFunctionManager {
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
    * @param props function app properties
+   * @param resourceOptions Optional settings to control resource behaviour
    * @see [Pulumi Azure Native Function App]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/web/webapp/}
    */
-  public createFunctionApp(id: string, scope: CommonAzureConstruct, props: FunctionAppProps) {
+  public createFunctionApp(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: FunctionAppProps,
+    resourceOptions?: ResourceOptions
+  ) {
     if (!props) throw `Props undefined for ${id}`
 
     // Get resource group name
@@ -52,7 +60,7 @@ export class AzureFunctionManager {
           environment: scope.props.stage,
         },
       },
-      { parent: scope }
+      { parent: scope, ...resourceOptions }
     )
   }
 
@@ -61,11 +69,17 @@ export class AzureFunctionManager {
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
    * @param props function properties
+   * @param resourceOptions Optional settings to control resource behaviour
    * @see [Pulumi Azure Native Function Envelope]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/web/webappfunction/}
    * @note In Pulumi, individual functions are typically deployed via code deployment rather than as separate infrastructure resources.
    * This method is provided for API compatibility but may require additional setup.
    */
-  public createFunction(id: string, scope: CommonAzureConstruct, props: FunctionProps) {
+  public createFunction(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: FunctionProps,
+    resourceOptions?: ResourceOptions
+  ) {
     if (!props) throw `Props undefined for ${id}`
 
     // Get resource group name
@@ -83,7 +97,7 @@ export class AzureFunctionManager {
         isDisabled: props.enabled !== undefined ? !props.enabled : false,
         testData: props.testData,
       } as any,
-      { parent: scope }
+      { parent: scope, ...resourceOptions }
     )
   }
 
@@ -92,12 +106,14 @@ export class AzureFunctionManager {
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
    * @param props flex consumption function app properties
+   * @param resourceOptions Optional settings to control resource behaviour
    * @see [Pulumi Azure Native Function App (Flex Consumption)]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/web/webapp/}
    */
   public createFunctionAppFlexConsumption(
     id: string,
     scope: CommonAzureConstruct,
-    props: FunctionAppFlexConsumptionProps
+    props: FunctionAppFlexConsumptionProps,
+    resourceOptions?: ResourceOptions
   ) {
     if (!props) throw `Props undefined for ${id}`
 
@@ -108,7 +124,7 @@ export class AzureFunctionManager {
 
     if (!resourceGroupName) throw `Resource group name undefined for ${id}`
 
-    return new WebApp(
+    const functionApp = new WebApp(
       `${id}-fc`,
       {
         ...props,
@@ -116,18 +132,148 @@ export class AzureFunctionManager {
         location: props.location ?? scope.props.location,
         resourceGroupName: resourceGroupName,
         kind: props.kind ?? 'functionapp,linux',
+        httpsOnly: props.httpsOnly ?? true,
         identity: props.identity ?? {
           type: ManagedServiceIdentityType.SystemAssigned,
         },
+        functionAppConfig: props.functionAppConfig ?? {
+          runtime: {
+            ...props.runtime,
+            name: props.runtime?.name ?? 'node',
+            version: props.runtime?.version ?? CommonAzureStack.NODEJS_RUNTIME,
+          },
+          scaleAndConcurrency: {
+            ...props.scaleAndConcurrency,
+            instanceMemoryMB: props.scaleAndConcurrency?.instanceMemoryMB ?? 4096,
+            maximumInstanceCount: props.scaleAndConcurrency?.maximumInstanceCount ?? 40,
+          },
+        },
         siteConfig: props.siteConfig ?? {
           http20Enabled: true,
-          linuxFxVersion: `${props.runtimeName ?? 'node'}|${props.runtimeVersion ?? '22'}`,
+          linuxFxVersion: `${props.runtime?.name ?? 'node'}|${props.runtime?.version ?? CommonAzureStack.NODEJS_RUNTIME}`,
         },
         tags: props.tags ?? {
           environment: scope.props.stage,
         },
       },
-      { parent: scope }
+      { parent: scope, ...resourceOptions }
+    )
+
+    const functionAppConfig = props.functionAppConfig as Record<string, any> | undefined
+
+    new Deployment(
+      `${id}-deployment`,
+      {
+        resourceGroupName: resourceGroupName,
+        properties: {
+          mode: DeploymentMode.Incremental,
+          template: {
+            $schema: 'https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#',
+            contentVersion: '1.0.0.0',
+            resources: [
+              {
+                type: 'Microsoft.Web/sites',
+                apiVersion: '2024-04-01',
+                name: scope.resourceNameFormatter.format(props.name, scope.props.resourceNameOptions?.functionApp),
+                location: props.location ?? scope.props.location,
+                properties: {
+                  functionAppConfig: {
+                    ...props.functionAppConfig,
+                    runtime: {
+                      ...props.runtime,
+                      name: props.runtime?.name ?? functionAppConfig?.runtime?.name ?? 'node',
+                      version:
+                        props.runtime?.version ??
+                        functionAppConfig?.runtime?.version ??
+                        CommonAzureStack.NODEJS_RUNTIME,
+                    },
+                    scaleAndConcurrency: {
+                      ...props.scaleAndConcurrency,
+                      instanceMemoryMB:
+                        props.scaleAndConcurrency?.instanceMemoryMB ??
+                        functionAppConfig?.scaleAndConcurrency?.instanceMemoryMB ??
+                        4096,
+                      maximumInstanceCount:
+                        props.scaleAndConcurrency?.maximumInstanceCount ??
+                        functionAppConfig?.scaleAndConcurrency?.maximumInstanceCount ??
+                        40,
+                    },
+                    siteUpdateStrategy: {
+                      type: 'RollingUpdate',
+                    },
+                  },
+                },
+              },
+            ],
+          },
+        },
+      },
+      { parent: scope, ...resourceOptions }
+    )
+
+    return functionApp
+  }
+
+  /**
+   * @summary Method to create a new flex consumption function app
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props flex consumption function app properties
+   * @param resourceOptions Optional settings to control resource behaviour
+   * @see [Pulumi Azure Native Function App (Flex Consumption)]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/web/webapp/}
+   */
+  public createFunctionAppFlexConsumptionResource(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: FunctionAppFlexConsumptionProps,
+    resourceOptions?: ResourceOptions
+  ) {
+    if (!props) throw `Props undefined for ${id}`
+
+    // Get resource group name
+    const resourceGroupName = scope.props.resourceGroupName
+      ? scope.resourceNameFormatter.format(scope.props.resourceGroupName)
+      : props.resourceGroupName
+
+    if (!resourceGroupName) throw `Resource group name undefined for ${id}`
+
+    return new Resource(
+      `${id}-fc`,
+      {
+        apiVersion: '2024-04-01',
+        identity: {
+          type: ManagedServiceIdentityType.SystemAssigned,
+        },
+        kind: props.kind ?? 'functionapp,linux',
+        location: props.location ?? scope.props.location,
+        parentResourcePath: '',
+        properties: {
+          httpsOnly: props.httpsOnly ?? true,
+          serverFarmId: props.serverFarmId,
+          siteConfig: props.siteConfig,
+          functionAppConfig: {
+            ...props.functionAppConfig,
+            runtime: {
+              ...props.runtime,
+              name: props.runtime?.name ?? 'node',
+              version: props.runtime?.version ?? CommonAzureStack.NODEJS_RUNTIME,
+            },
+            scaleAndConcurrency: {
+              ...props.scaleAndConcurrency,
+              instanceMemoryMB: props.scaleAndConcurrency?.instanceMemoryMB ?? 4096,
+              maximumInstanceCount: props.scaleAndConcurrency?.maximumInstanceCount ?? 40,
+            },
+            siteUpdateStrategy: {
+              type: 'RollingUpdate',
+            },
+          },
+        },
+        resourceGroupName: resourceGroupName,
+        resourceName: scope.resourceNameFormatter.format(props.name, scope.props.resourceNameOptions?.functionApp),
+        resourceProviderNamespace: 'Microsoft.Web',
+        resourceType: 'sites',
+      },
+      { parent: scope, ...resourceOptions }
     )
   }
 }

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

@@ -1,3 +1,4 @@
+import { input } from '@pulumi/azure-native/types/index.js'
 import { WebAppArgs } from '@pulumi/azure-native/web/index.js'
 
 export interface FunctionAppProps extends WebAppArgs {
@@ -15,10 +16,8 @@ export interface FunctionProps {
 
 export interface FunctionAppFlexConsumptionProps extends WebAppArgs {
   name?: string
-  runtimeName?: string
-  runtimeVersion?: string
+  runtime?: input.web.FunctionsRuntimeArgs
+  scaleAndConcurrency?: input.web.FunctionsScaleAndConcurrencyArgs
   storageAuthenticationType?: string
   storageContainerType?: string
-  maximumInstanceCount?: number
-  instanceMemoryInMb?: number
 }

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

@@ -2,14 +2,17 @@ export * from './api-management/index.js'
 export * from './app-configuration/index.js'
 export * from './app-service/index.js'
 export * from './application-insights/index.js'
+export * from './authorisation/index.js'
 export * from './cosmosdb/index.js'
 export * from './dns/index.js'
 export * from './eventgrid/index.js'
 export * from './function/index.js'
 export * from './key-vault/index.js'
 export * from './operational-insights/index.js'
+export * from './portal/index.js'
 export * from './monitor/index.js'
 export * from './redis/index.js'
 export * from './resource-group/index.js'
+export * from './security-center/index.js'
 export * from './servicebus/index.js'
 export * from './storage/index.js'

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

@@ -1,6 +1,7 @@
-import { SkuFamily, SkuName, Vault } from '@pulumi/azure-native/keyvault/index.js'
+import { getVaultOutput, Secret, SkuFamily, SkuName, Vault } from '@pulumi/azure-native/keyvault/index.js'
+import { ResourceOptions } from '@pulumi/pulumi'
 import { CommonAzureConstruct } from '../../common/index.js'
-import { KeyVaultProps } from './types.js'
+import { KeyVaultProps, SecretProps } from './types.js'
 
 /**
  * @classdesc Provides operations on Azure Key Vault using Pulumi
@@ -25,9 +26,15 @@ export class AzureKeyVaultManager {
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
    * @param props key vault properties
+   * @param resourceOptions Optional settings to control resource behaviour
    * @see [Pulumi Azure Native Key Vault]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/keyvault/vault/}
    */
-  public createKeyVault(id: string, scope: CommonAzureConstruct, props: KeyVaultProps) {
+  public createKeyVault(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: KeyVaultProps,
+    resourceOptions?: ResourceOptions
+  ) {
     if (!props) throw `Props undefined for ${id}`
 
     // Get resource group name
@@ -63,7 +70,43 @@ export class AzureKeyVaultManager {
           environment: scope.props.stage,
         },
       },
-      { parent: scope }
+      { parent: scope, ...resourceOptions }
     )
   }
+
+  /**
+   *
+   * @summary Method to create a new key vault secret
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props key vault secret properties
+   * @param resourceOptions Optional settings to control resource behaviour
+   * @see [Pulumi Azure Native Key Vault Secret]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/keyvault/secret/}
+   */
+  public createKeyVaultSecret(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: SecretProps,
+    resourceOptions?: ResourceOptions
+  ) {
+    if (!props) throw `Props undefined for ${id}`
+
+    return new Secret(`${id}`, props, { parent: scope, ...resourceOptions })
+  }
+
+  /**
+   * @summary Method to resolve an existing key vault
+   * @param scope scope in which this resource is defined
+   * @param vaultName the key vault name
+   * @param resourceGroupName the resource group name
+   * @param resourceOptions Optional settings to control resource behaviour
+   */
+  public resolveKeyVault(
+    scope: CommonAzureConstruct,
+    vaultName: string,
+    resourceGroupName: string,
+    resourceOptions?: ResourceOptions
+  ) {
+    return getVaultOutput({ vaultName, resourceGroupName }, { parent: scope, ...resourceOptions })
+  }
 }

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

@@ -1,5 +1,5 @@
-import { VaultArgs } from '@pulumi/azure-native/keyvault/index.js'
+import { SecretArgs, VaultArgs } from '@pulumi/azure-native/keyvault/index.js'
 
-export interface KeyVaultProps extends VaultArgs {
-  name?: string
-}
+export interface KeyVaultProps extends VaultArgs {}
+
+export interface SecretProps extends SecretArgs {}

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

@@ -1,4 +1,5 @@
 import { DiagnosticSetting } from '@pulumi/azure-native/monitor/index.js'
+import { ResourceOptions } from '@pulumi/pulumi'
 import { CommonAzureConstruct } from '../../common/index.js'
 import { MonitorDiagnosticSettingProps } from './types.js'
 
@@ -25,12 +26,14 @@ export class AzureMonitorManager {
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
    * @param props monitor diagnostics settings properties
+   * @param resourceOptions Optional settings to control resource behaviour
    * @see [Pulumi Azure Native Monitor Diagnostic Settings]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/insights/diagnosticsetting/}
    */
   public createMonitorDiagnosticSettings(
     id: string,
     scope: CommonAzureConstruct,
-    props: MonitorDiagnosticSettingProps
+    props: MonitorDiagnosticSettingProps,
+    resourceOptions?: ResourceOptions
   ) {
     if (!props) throw `Props undefined for ${id}`
 
@@ -43,7 +46,7 @@ export class AzureMonitorManager {
           scope.props.resourceNameOptions?.monitorDiagnosticSetting
         ),
       },
-      { parent: scope }
+      { parent: scope, ...resourceOptions }
     )
   }
 }

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

@@ -1,6 +1,7 @@
-import { Workspace, WorkspaceSkuNameEnum } from '@pulumi/azure-native/operationalinsights/index.js'
+import { Table, Workspace, WorkspaceSkuNameEnum } from '@pulumi/azure-native/operationalinsights/index.js'
+import { ResourceOptions } from '@pulumi/pulumi'
 import { CommonAzureConstruct } from '../../common/index.js'
-import { WorkspaceProps } from './types.js'
+import { WorkspaceProps, WorkspaceTableProps } from './types.js'
 
 /**
  * @classdesc Provides operations on Azure Log Analytics Workspace using Pulumi
@@ -25,9 +26,15 @@ export class AzureOperationalInsightsManager {
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
    * @param props log analytics workspace properties
+   * @param resourceOptions Optional settings to control resource behaviour
    * @see [Pulumi Azure Native Operational Insights Workspace]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/operationalinsights/workspace/}
    */
-  public createWorkspace(id: string, scope: CommonAzureConstruct, props: WorkspaceProps) {
+  public createWorkspace(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: WorkspaceProps,
+    resourceOptions?: ResourceOptions
+  ) {
     if (!props) throw `Props undefined for ${id}`
 
     // Get resource group name
@@ -55,7 +62,26 @@ export class AzureOperationalInsightsManager {
           environment: scope.props.stage,
         },
       },
-      { parent: scope }
+      { parent: scope, ...resourceOptions }
     )
   }
+
+  /**
+   * @summary Method to create a new log analytics workspace table
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props log analytics workspace table properties
+   * @param resourceOptions Optional settings to control resource behaviour
+   * @see [Pulumi Azure Native Operational Insights Table]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/operationalinsights/table/}
+   */
+  public createTable(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: WorkspaceTableProps,
+    resourceOptions?: ResourceOptions
+  ) {
+    if (!props) throw `Props undefined for ${id}`
+
+    return new Table(`${id}`, props, { parent: scope, ...resourceOptions })
+  }
 }

package/src/lib/azure/services/operational-insights/types.ts

@@ -1,3 +1,5 @@
-import { WorkspaceArgs } from '@pulumi/azure-native/operationalinsights/index.js'
+import { TableArgs, WorkspaceArgs } from '@pulumi/azure-native/operationalinsights/index.js'
 
 export interface WorkspaceProps extends WorkspaceArgs {}
+
+export interface WorkspaceTableProps extends TableArgs {}

package/src/lib/azure/services/portal/error.ts

@@ -0,0 +1,12 @@
+export class TemplateError extends Error {
+  public readonly isTemplateError = true
+
+  constructor(message: string) {
+    super(message)
+    this.name = 'TemplateError'
+  }
+
+  static isInstance(error: unknown): error is TemplateError {
+    return error instanceof Object && 'isTemplateError' in error && error.isTemplateError === true
+  }
+}

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

@@ -0,0 +1,4 @@
+export * from './error.js'
+export * from './main.js'
+export * from './renderer.js'
+export * from './types.js'

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

@@ -0,0 +1,81 @@
+import { Dashboard } from '@pulumi/azure-native/portal/index.js'
+import { ResourceOptions } from '@pulumi/pulumi'
+import fs from 'fs'
+import { CommonAzureConstruct } from '../../index.js'
+import { AzureDashboardRenderer } from './renderer.js'
+import { PortalDashboardProps } from './types.js'
+
+/**
+ * @classdesc Provides operations on Azure Portal Dashboards using Pulumi
+ * - 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
+ * ```typescript
+ * import { CommonAzureConstruct, CommonAzureStackProps } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonAzureConstruct {
+ *   constructor(name: string, props: CommonAzureStackProps) {
+ *     super(name, props)
+ *     this.props = props
+ *     this.azurePortalManager.createDashBoard('MyDashboard', this, props)
+ *   }
+ * }
+ * ```
+ */
+export class AzurePortalManager {
+  /**
+   * @summary Method to create a new portal dashboard
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props  the dashboard properties
+   * @param renderer An optional renderer to use
+   * @param resourceOptions Optional settings to control resource behaviour
+   * @see [Pulumi Azure Native Portal Dashboard]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/portal/dashboard/}
+   */
+  public createDashBoard(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: PortalDashboardProps,
+    renderer?: AzureDashboardRenderer,
+    resourceOptions?: ResourceOptions
+  ) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const resourceGroup = scope.resourceGroupManager.resolveResourceGroup(
+      scope,
+      props.resourceGroupName.toString() ?? scope.props.resourceGroupName,
+      resourceOptions
+    )
+
+    const dashboardName = scope.resourceNameFormatter.format(
+      props.dashboardName?.toString(),
+      scope.props.resourceNameOptions?.portalDashboard
+    )
+
+    const dashboardRenderer = renderer ?? new AzureDashboardRenderer()
+    const templateFile = dashboardRenderer.renderToFile(dashboardName, props)
+    const template = fs.readFileSync(templateFile, 'utf-8')
+    const content = Object.entries(props.variables).reduce(
+      (result, [key, value]) => result.replaceAll(`\${${key}}`, String(value)),
+      template
+    )
+
+    return new Dashboard(
+      `${id}-dashboard`,
+      {
+        ...props,
+        dashboardName: scope.resourceNameFormatter.format(
+          props.dashboardName?.toString(),
+          scope.props.resourceNameOptions?.portalDashboard
+        ),
+        resourceGroupName: resourceGroup.name,
+        location: props.location ?? resourceGroup.location,
+        properties: JSON.parse(content),
+        tags: {
+          'hidden-title': `${props.location} - ${props.displayName}`,
+        },
+      },
+      { ...resourceOptions, ignoreChanges: ['location'] }
+    )
+  }
+}