@gradientedge/cdk-utils 9.35.0 → 9.37.0

package/src/lib/azure/.gen/versions.json

@@ -0,0 +1,3 @@
+{
+  "registry.terraform.io/azure/azapi": "2.2.0"
+}

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

@@ -1,4 +1,5 @@
 import { AzurermProvider } from '@cdktf/provider-azurerm/lib/provider'
+import { AzapiProvider } from '../.gen/providers/azapi/provider'
 import { DataAzurermClientConfig } from '@cdktf/provider-azurerm/lib/data-azurerm-client-config'
 import { AzurermBackend, TerraformStack } from 'cdktf'
 import { Construct } from 'constructs'
@@ -12,6 +13,7 @@ import {
   AzureAppServiceManager,
   AzureApplicationInsightsManager,
   AzureAppConfigurationManager,
+  AzureCosmosDbManager,
 } from '../services'
 import { CommonAzureStackProps } from './types'
 import { AzureRemoteBackend } from './constants'
@@ -25,6 +27,7 @@ export class CommonAzureConstruct extends TerraformStack {
   appServiceManager: AzureAppServiceManager
   applicationInsightsManager: AzureApplicationInsightsManager
   appConfigurationManager: AzureAppConfigurationManager
+  cosmosDbManager: AzureCosmosDbManager
   functiontManager: AzureFunctionManager
   keyVaultManager: AzureKeyVaultManager
   resourceGroupManager: AzureResourceGroupManager
@@ -39,6 +42,7 @@ export class CommonAzureConstruct extends TerraformStack {
     this.appServiceManager = new AzureAppServiceManager()
     this.applicationInsightsManager = new AzureApplicationInsightsManager()
     this.appConfigurationManager = new AzureAppConfigurationManager()
+    this.cosmosDbManager = new AzureCosmosDbManager()
     this.functiontManager = new AzureFunctionManager()
     this.keyVaultManager = new AzureKeyVaultManager()
     this.resourceGroupManager = new AzureResourceGroupManager()
@@ -48,6 +52,7 @@ export class CommonAzureConstruct extends TerraformStack {
     this.determineRemoteBackend()
     this.determineTenantId()
     new AzurermProvider(this, `${this.id}-provider`, this.props)
+    new AzapiProvider(this, `${this.id}-azapi-provider`, this.props)
   }
 
   /**

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

@@ -154,9 +154,12 @@ export class AzureApiManagementManager {
       displayName: props.displayName || props.name,
       revision: props.revision || '1',
       protocols: props.protocols || ['https'],
-      subscriptionRequired: props.subscriptionRequired || true,
     })
 
+    createAzureTfOutput(`${id}-apiManagementApiName`, scope, apiManagementApi.name)
+    createAzureTfOutput(`${id}-apiManagementApiFriendlyUniqueId`, scope, apiManagementApi.friendlyUniqueId)
+    createAzureTfOutput(`${id}-apiManagementApiId`, scope, apiManagementApi.id)
+
     _.forEach(props.operations, operation => {
       const apimOperation = new ApiManagementApiOperation(
         scope,
@@ -172,18 +175,6 @@ export class AzureApiManagementManager {
         }
       )
 
-      const apimOperationPolicy = new ApiManagementApiOperationPolicy(
-        scope,
-        `${id}-apim-api-operation-policy-${operation.path}-${operation.method}`,
-        {
-          apiManagementName: apiManagementApi.apiManagementName,
-          resourceGroupName: apiManagementApi.resourceGroupName,
-          apiName: apiManagementApi.name,
-          operationId: apimOperation.operationId,
-          xmlContent: operation.xmlContent,
-        }
-      )
-
       createAzureTfOutput(
         `${id}-${operation.path}-${operation.method}-apimOperationOperationId`,
         scope,
@@ -196,22 +187,32 @@ export class AzureApiManagementManager {
       )
       createAzureTfOutput(`${id}-${operation.path}-${operation.method}-apimOperationId`, scope, apimOperation.id)
 
-      createAzureTfOutput(
-        `${id}-${operation.path}-${operation.method}-apimOperationPolicyFriendlyUniqueId`,
-        scope,
-        apimOperationPolicy.friendlyUniqueId
-      )
-      createAzureTfOutput(
-        `${id}-${operation.path}-${operation.method}-apimOperationPolicyId`,
-        scope,
-        apimOperationPolicy.id
-      )
+      if (props.policyXmlContent) {
+        const apimOperationPolicy = new ApiManagementApiOperationPolicy(
+          scope,
+          `${id}-apim-api-operation-policy-${operation.path}-${operation.method}`,
+          {
+            apiManagementName: apiManagementApi.apiManagementName,
+            resourceGroupName: apiManagementApi.resourceGroupName,
+            apiName: apiManagementApi.name,
+            operationId: apimOperation.operationId,
+            xmlContent: props.policyXmlContent,
+          }
+        )
+
+        createAzureTfOutput(
+          `${id}-${operation.path}-${operation.method}-apimOperationPolicyFriendlyUniqueId`,
+          scope,
+          apimOperationPolicy.friendlyUniqueId
+        )
+        createAzureTfOutput(
+          `${id}-${operation.path}-${operation.method}-apimOperationPolicyId`,
+          scope,
+          apimOperationPolicy.id
+        )
+      }
     })
 
-    createAzureTfOutput(`${id}-apiManagementApiName`, scope, apiManagementApi.name)
-    createAzureTfOutput(`${id}-apiManagementApiFriendlyUniqueId`, scope, apiManagementApi.friendlyUniqueId)
-    createAzureTfOutput(`${id}-apiManagementApiId`, scope, apiManagementApi.id)
-
     return apiManagementApi
   }
 }

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

@@ -10,10 +10,10 @@ export interface ApiManagementBackendProps extends ApiManagementBackendConfig {}
 
 export interface ApiManagementApiProps extends ApiManagementApiConfig {
   operations: OperationsProps[]
+  policyXmlContent?: ApiManagementApiOperationPolicyConfig['xmlContent']
 }
 
 export interface OperationsProps {
   path: ApiManagementApiOperationConfig['urlTemplate']
   method: ApiManagementApiOperationConfig['method']
-  xmlContent?: ApiManagementApiOperationPolicyConfig['xmlContent']
 }

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

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

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

@@ -0,0 +1,124 @@
+import { DataAzurermResourceGroup } from '@cdktf/provider-azurerm/lib/data-azurerm-resource-group'
+import { CosmosdbAccount } from '@cdktf/provider-azurerm/lib/cosmosdb-account'
+import { CosmosdbSqlDatabase } from '@cdktf/provider-azurerm/lib/cosmosdb-sql-database'
+import { CosmosdbSqlContainer } from '@cdktf/provider-azurerm/lib/cosmosdb-sql-container'
+import { CosmosdbTable } from '@cdktf/provider-azurerm/lib/cosmosdb-table'
+import { CommonAzureConstruct } from '../../common'
+import { createAzureTfOutput } from '../../utils'
+import { CosmosdbAccountProps, CosmosdbTableProps, CosmosdbSqlContainerProps, CosmosdbSqlDatabaseProps } from './types'
+
+/**
+ * @classdesc Provides operations on Azure CosmosDB
+ * - 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.CosmosDbManager.createCosmosAccount('MyCosmosDb', this, props)
+ *   }
+ * }
+ * ```
+ */
+export class AzureCosmosDbManager {
+  /**
+   * @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/cosmosdbAccount.typescript.md}
+   */
+  public createCosmosDbAccount(id: string, scope: CommonAzureConstruct, props: CosmosdbAccountProps) {
+    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}`,
+    })
+
+    if (!resourceGroup) throw `Resource group undefined for ${id}`
+
+    const cosmosdbAccount = new CosmosdbAccount(scope, `${id}-ca`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+      location: resourceGroup.location,
+      resourceGroupName: resourceGroup.name,
+      tags: props.tags ?? {
+        environment: scope.props.stage,
+      },
+    })
+
+    createAzureTfOutput(`${id}-cosmosdbAccountName`, scope, cosmosdbAccount.name)
+    createAzureTfOutput(`${id}-cosmosdbAccountFriendlyUniqueId`, scope, cosmosdbAccount.friendlyUniqueId)
+    createAzureTfOutput(`${id}-cosmosdbAccountId`, scope, cosmosdbAccount.id)
+
+    return cosmosdbAccount
+  }
+
+  /**
+   * @summary Method to create a new cosmosdb database
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props cosmosdb container properties
+   * @see [CDKTF CosmosDb Container Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/cosmosdbSqlContainer.typescript.md}
+   */
+  public createCosmosDbDatabase(id: string, scope: CommonAzureConstruct, props: CosmosdbSqlDatabaseProps) {
+    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}`,
+    })
+
+    if (!resourceGroup) throw `Resource group undefined for ${id}`
+
+    const cosmosdbDatatbase = new CosmosdbSqlDatabase(scope, `${id}-cd`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+      resourceGroupName: resourceGroup.name,
+    })
+
+    createAzureTfOutput(`${id}-cosmosdbDatatbasetName`, scope, cosmosdbDatatbase.name)
+    createAzureTfOutput(`${id}-cosmosdbDatatbaseFriendlyUniqueId`, scope, cosmosdbDatatbase.friendlyUniqueId)
+    createAzureTfOutput(`${id}-cosmosdbDatatbaseId`, scope, cosmosdbDatatbase.id)
+
+    return cosmosdbDatatbase
+  }
+
+  /**
+   * @summary Method to create a new cosmosdb container
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props cosmosdb container properties
+   * @see [CDKTF CosmosDb Container Module]{@link https://github.com/cdktf/cdktf-provider-azurerm/blob/main/docs/cosmosdbSqlContainer.typescript.md}
+   */
+  public createCosmosDbContainer(id: string, scope: CommonAzureConstruct, props: CosmosdbSqlContainerProps) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-cc-rg`, {
+      name: scope.props.resourceGroupName
+        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
+        : `${props.resourceGroupName}`,
+    })
+
+    if (!resourceGroup) throw `Resource group undefined for ${id}`
+
+    const cosmosdbContainer = new CosmosdbSqlContainer(scope, `${id}-cc`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+      resourceGroupName: resourceGroup.name,
+    })
+
+    createAzureTfOutput(`${id}-cosmosdbContainertName`, scope, cosmosdbContainer.name)
+    createAzureTfOutput(`${id}-cosmosdbContainerFriendlyUniqueId`, scope, cosmosdbContainer.friendlyUniqueId)
+    createAzureTfOutput(`${id}-cosmosdbContainerId`, scope, cosmosdbContainer.id)
+
+    return cosmosdbContainer
+  }
+}

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

@@ -0,0 +1,9 @@
+import { CosmosdbAccountConfig } from '@cdktf/provider-azurerm/lib/cosmosdb-account'
+import { CosmosdbSqlDatabaseConfig } from '@cdktf/provider-azurerm/lib/cosmosdb-sql-database'
+import { CosmosdbSqlContainerConfig } from '@cdktf/provider-azurerm/lib/cosmosdb-sql-container'
+import { CosmosdbTableConfig } from '@cdktf/provider-azurerm/lib/cosmosdb-table'
+
+export interface CosmosdbAccountProps extends CosmosdbAccountConfig {}
+export interface CosmosdbSqlDatabaseProps extends CosmosdbSqlDatabaseConfig {}
+export interface CosmosdbSqlContainerProps extends CosmosdbSqlContainerConfig {}
+export interface CosmosdbTableProps extends CosmosdbTableConfig {}

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

@@ -1,9 +1,11 @@
 import { DataAzurermResourceGroup } from '@cdktf/provider-azurerm/lib/data-azurerm-resource-group'
+import { DataAzurermLinuxFunctionApp } from '@cdktf/provider-azurerm/lib/data-azurerm-linux-function-app'
 import { LinuxFunctionApp } from '@cdktf/provider-azurerm/lib/linux-function-app'
 import { FunctionAppFunction } from '@cdktf/provider-azurerm/lib/function-app-function'
+import { Resource } from '../../.gen/providers/azapi/resource'
 import { CommonAzureConstruct } from '../../common'
 import { createAzureTfOutput } from '../../utils'
-import { FunctionAppProps, FunctionProps } from './types'
+import { FunctionAppProps, FunctionProps, FunctionAppFlexConsumptionProps } from './types'
 
 /**
  * @classdesc Provides operations on Azure Functions
@@ -16,7 +18,7 @@ import { FunctionAppProps, FunctionProps } from './types'
  * class CustomConstruct extends CommonAzureConstruct {
  *   constructor(parent: Construct, id: string, props: CommonAzureStackProps) {
  *     super(parent, id, props)
- *     this.props = props
+ *     this.props: props
  *     this.functionManager.createFunctionApp('MyFunctionApp', this, props)
  *   }
  * }
@@ -79,4 +81,95 @@ export class AzureFunctionManager {
 
     return functionAppFunction
   }
+
+  /**
+   * @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
+   */
+  public createFunctionAppFlexConsumption(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: FunctionAppFlexConsumptionProps
+  ) {
+    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}`,
+    })
+
+    if (!resourceGroup) throw `Resource group undefined for ${id}`
+
+    const functionApp = new Resource(scope, `${id}-fa`, {
+      type: 'Microsoft.Web/sites@2023-12-01',
+      name: `${props.name}-${scope.props.stage}`,
+      location: resourceGroup.location,
+      parentId: resourceGroup.id,
+
+      body: {
+        kind: props.kind || 'functionapp,linux',
+
+        properties: {
+          serverFarmId: props.appServicePlanId,
+          httpsOnly: props.httpsOnly || true,
+
+          functionAppConfig: {
+            deployment: {
+              storage: {
+                type: props.deploymentStorageType || 'blobContainer',
+                value: `${props.blobEndpoint}${props.containerName}`,
+                authentication: {
+                  type: props.deploymentAuthenticationType || 'StorageAccountConnectionString',
+                  storageAccountConnectionStringName:
+                    props.storageAccountConnectionStringName || 'DEPLOYMENT_STORAGE_CONNECTION_STRING',
+                },
+              },
+            },
+            runtime: {
+              name: props.runtime || 'node',
+              version: props.runtimeVersion || '20',
+            },
+            scaleAndConcurrency: {
+              instanceMemoryMB: props.instanceMemory || 2048,
+              maximumInstanceCount: props.maximumInstanceCount || 40,
+              triggers: {},
+            },
+          },
+
+          siteConfig: {
+            appSettings: props.appSettings.concat([
+              {
+                name: 'FUNCTIONS_EXTENSION_VERSION',
+                value: '~4',
+              },
+              {
+                name: 'AzureWebJobsStorage',
+                value: props.storageConnectionString,
+              },
+              {
+                name: 'DEPLOYMENT_STORAGE_CONNECTION_STRING',
+                value: props.storageConnectionString,
+              },
+            ]),
+          },
+        },
+      },
+
+      identity: [{ type: 'SystemAssigned' }],
+
+      ignoreMissingProperty: true,
+      ignoreCasing: true,
+      schemaValidationEnabled: false,
+    })
+
+    const functionAppFlexConsumption = new DataAzurermLinuxFunctionApp(scope, `${id}-fa-flex`, {
+      name: functionApp.name,
+      resourceGroupName: resourceGroup.name,
+    })
+
+    return functionAppFlexConsumption
+  }
 }

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

@@ -1,7 +1,26 @@
 import { LinuxFunctionAppConfig } from '@cdktf/provider-azurerm/lib/linux-function-app'
 import { FunctionAppFunctionConfig } from '@cdktf/provider-azurerm/lib/function-app-function'
-import { BaseAzureConfigProps } from '../../types'
+import { ResourceConfig } from '../../.gen/providers/azapi/resource'
 
 export interface FunctionAppProps extends LinuxFunctionAppConfig {}
 
 export interface FunctionProps extends FunctionAppFunctionConfig {}
+
+export interface FunctionAppFlexConsumptionProps {
+  appServicePlanId: string
+  appSettings: any
+  blobEndpoint: string
+  containerName: string
+  deploymentAuthenticationType?: string
+  deploymentStorageType?: string
+  httpsOnly?: string
+  instanceMemory?: number
+  kind?: string
+  maximumInstanceCount?: number
+  name: string
+  resourceGroupName: string
+  runtime?: string
+  runtimeVersion?: string
+  storageAccountConnectionStringName?: string
+  storageConnectionString: string
+}

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

@@ -2,6 +2,7 @@ export * from './api-management'
 export * from './app-configuration'
 export * from './app-service'
 export * from './application-insights'
+export * from './cosmosdb'
 export * from './function'
 export * from './key-vault'
 export * from './resource-group'

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

@@ -81,14 +81,15 @@ export class AzureStorageManager {
     if (!resourceGroup) throw `Resource group undefined for ${id}`
 
     const storageAccount = new DataAzurermStorageAccount(scope, `${id}-sa`, {
-      name: `${props.storageAccountName}-${scope.props.stage}`,
+      name: `${props.storageAccountName}-${scope.props.stage}`.replace(/\W/g, '').toLowerCase(),
       resourceGroupName: resourceGroup.name,
     })
 
     const storageContainer = new StorageContainer(scope, `${id}-sc`, {
       ...props,
       name: `${props.name}-${scope.props.stage}`,
-      storageAccountName: storageAccount.name,
+      storageAccountName: undefined, // the `storage_account_name` property has been deprecated in favour of `storage_account_id` and will be removed in version 5.0 of the Provider.
+      storageAccountId: storageAccount.id,
     })
 
     createAzureTfOutput(`${id}-storageContainerName`, scope, storageContainer.name)
@@ -123,7 +124,8 @@ export class AzureStorageManager {
 
     const storageContainer = new DataAzurermStorageContainer(scope, `${id}-sc`, {
       name: `${props.storageContainerName}-${scope.props.stage}`,
-      storageAccountName: storageAccount.name,
+      storageAccountName: undefined, // the `storage_account_name` property has been deprecated in favour of `storage_account_id` and will be removed in version 5.0 of the Provider.
+      storageAccountId: storageAccount.id,
     })
 
     const storageBlob = new StorageBlob(scope, `${id}-sb`, {