Class AzureEventHandler

Provides a construct to create and deploy an Azure EventGrid Event Handler with Service Bus integration

Example

import { AzureEventHandler, AzureEventHandlerProps } from '@gradientedge/cdk-utils'

class CustomConstruct extends AzureEventHandler {
  constructor(id: string, props: AzureEventHandlerProps) {
    super(id, props)
    this.props = props
    this.id = id
    this.initResources()
  }
}

Hierarchy (View Summary)

AzureFunctionApp
- AzureEventHandler

Index

Constructors

constructor

new AzureEventHandler(
id: string,
props: AzureEventHandlerProps,
): AzureEventHandler
Parameters
- id: string
  scoped id of the resource
- props: AzureEventHandlerProps
  the event handler properties
Returns AzureEventHandler
Overrides AzureFunctionApp.constructor
- Defined in packages/azure/src/construct/event-handler/main.ts:40

Properties

apiManagementManager

apiManagementManager: AzureApiManagementManager

Manager for Azure API Management resources

app

app: WebApp

The provisioned Azure Function App web app resource

appCodeArchiveFile

appCodeArchiveFile: Output<GetFileResult>

The archive file output for the function app deployment package

appConfig

appConfig: ConfigurationStore | Output<GetConfigurationStoreResult>

The provisioned or resolved App Configuration store

appConfigHash

appConfigHash: string

Hash of the app configuration for change detection

`Optional`appConfigPrefix

appConfigPrefix?: string

Prefix for App Configuration key names

appConfigRoleAssignment

appConfigRoleAssignment: RoleAssignment

Role assignment granting the function app access to the App Configuration store

appConfigurationManager

appConfigurationManager: AzureAppConfigurationManager

Manager for Azure App Configuration resources

appConfigurationsOriginalParsedConfig

appConfigurationsOriginalParsedConfig: any

Parsed app configuration data (original version before processing)

appConfigurationsParsedConfig

appConfigurationsParsedConfig: any

Parsed app configuration data (processed version)

appConnectionStrings

appConnectionStrings: any[] = []

Connection strings to configure on the function app

appDeploymentStorageContainer

appDeploymentStorageContainer: BlobContainer

The provisioned storage container for deployment artifacts

appEnvironmentVariables

appEnvironmentVariables: Record<string, any> = {}

Environment variables to inject into the function app configuration

appKeyVaultsByResourceGroup

appKeyVaultsByResourceGroup: Map<string, Set<string>> = ...

Map of resource group names to sets of Key Vault names for role assignments

applicationInsights

applicationInsights: Output<GetComponentResult>

The resolved Application Insights component for telemetry

applicationInsightsManager

applicationInsightsManager: AzureApplicationInsightsManager

Manager for Azure Application Insights resources

appServiceManager

appServiceManager: AzureAppServiceManager

Manager for Azure App Service resources

appServicePlan

appServicePlan: AppServicePlan

The provisioned App Service Plan for the function app

appStorageAccount

appStorageAccount: StorageAccount

The provisioned storage account for the function app

appStorageContainer

appStorageContainer: BlobContainer

The provisioned storage container for function app data

authorisationManager

authorisationManager: AzureAuthorisationManager

Manager for Azure RBAC role assignments

commonLogAnalyticsWorkspace

commonLogAnalyticsWorkspace: Workspace | Output<GetWorkspaceResult>

Shared Log Analytics Workspace resolved from props, used for diagnostic logging

cosmosDbManager

cosmosDbManager: AzureCosmosDbManager

Manager for Azure CosmosDB resources

dataKeyVault

dataKeyVault: Vault

The provisioned Key Vault for data storage secrets

dataStorageAccount

dataStorageAccount: StorageAccount

The provisioned data storage account

dataStorageContainer

dataStorageContainer: BlobContainer

The provisioned data storage container

dnsManager

dnsManager: AzureDnsManager

Manager for Azure DNS resources

eventGridEventSubscription

eventGridEventSubscription: EventHandlerEventGridSubscription

Provisioned EventGrid subscription resources including dead-letter storage

eventgridManager

eventgridManager: AzureEventgridManager

Manager for Azure Event Grid resources

eventGridRoleAssignment

eventGridRoleAssignment: RoleAssignment

Role assignment granting the function app access to EventGrid topics

eventGridTopic

eventGridTopic: Output<GetTopicResult> | Topic

The provisioned or resolved EventGrid topic

fullyQualifiedDomainName

fullyQualifiedDomainName: string

The fully qualified domain name derived from domainName and subDomain

functionDashboard

functionDashboard: Dashboard

The provisioned Azure Portal dashboard for monitoring

functionManager

functionManager: AzureFunctionManager

Manager for Azure Function App resources

id

id: string

Unique identifier for the construct

keyVaultManager

keyVaultManager: AzureKeyVaultManager

Manager for Azure Key Vault resources

monitorManager

monitorManager: AzureMonitorManager

Manager for Azure Monitor diagnostic settings

operationalInsightsManager

operationalInsightsManager: AzureOperationalInsightsManager

Manager for Azure Log Analytics Workspace resources

`Optional`options

options?: ComponentResourceOptions

Optional Pulumi component resource options

portalManager

portalManager: AzurePortalManager

Manager for Azure Portal Dashboard resources

props

props: AzureEventHandlerProps

Event handler properties

redisManager

redisManager: AzureRedisManager

Manager for Azure Managed Redis (Enterprise) resources

resourceGroup

resourceGroup: ResourceGroup

The Azure resource group associated with this construct

resourceGroupManager

resourceGroupManager: AzureResourceGroupManager

Manager for Azure Resource Group resources

resourceNameFormatter

resourceNameFormatter: AzureResourceNameFormatter

Formatter for Azure resource names based on naming conventions

securityCentermanager

securityCentermanager: AzureSecurityCentermanager

Manager for Azure Security Center (Defender) resources

serviceBus

serviceBus: EventHandlerServiceBus

Provisioned Service Bus resources (namespace and queue)

serviceBusManager

serviceBusManager: AzureServiceBusManager

Manager for Azure Service Bus resources

storageManager

storageManager: AzureStorageManager

Manager for Azure Storage resources

storageRoleAssignment

storageRoleAssignment: RoleAssignment

Role assignment granting the function app access to the storage account

`Readonly`urn

urn: Output<string>

The stable logical URN used to distinctly address a resource, both before and after deployments.

Methods

`Protected`createAppConfiguration

createAppConfiguration(): void
Returns void
Inherited from AzureFunctionApp.createAppConfiguration
- Defined in packages/azure/src/construct/function-app/main.ts:166

`Protected`createAppConfigurations

createAppConfigurations(): void
Returns void
Inherited from AzureFunctionApp.createAppConfigurations
- Defined in packages/azure/src/construct/function-app/main.ts:186

`Protected`createAppServicePlan

createAppServicePlan(): void
Returns void
Inherited from AzureFunctionApp.createAppServicePlan
- Defined in packages/azure/src/construct/function-app/main.ts:147

`Protected`createCodePackage

createCodePackage(): void
Returns void
Inherited from AzureFunctionApp.createCodePackage
- Defined in packages/azure/src/construct/function-app/main.ts:344

`Protected`createDataStorageAccount

createDataStorageAccount(): void
Returns void
Inherited from AzureFunctionApp.createDataStorageAccount
- Defined in packages/azure/src/construct/function-app/main.ts:235

`Protected`createDataStorageContainer

createDataStorageContainer(): void
Returns void
Inherited from AzureFunctionApp.createDataStorageContainer
- Defined in packages/azure/src/construct/function-app/main.ts:253

`Protected`createdParsedAppConfigurations

createdParsedAppConfigurations(): void
Returns void
Inherited from AzureFunctionApp.createdParsedAppConfigurations
- Defined in packages/azure/src/construct/function-app/main.ts:161

`Protected`createEventGrid

createEventGrid(): void
Returns void
- Defined in packages/azure/src/construct/event-handler/main.ts:160

`Protected`createEventGridEventSubscription

createEventGridEventSubscription(): void
Returns void
- Defined in packages/azure/src/construct/event-handler/main.ts:200

`Protected`createEventGridSubscriptionDlqStorageAccount

createEventGridSubscriptionDlqStorageAccount(): void
Returns void
- Defined in packages/azure/src/construct/event-handler/main.ts:69

`Protected`createEventGridSubscriptionDlqStorageContainer

createEventGridSubscriptionDlqStorageContainer(): void
Returns void
- Defined in packages/azure/src/construct/event-handler/main.ts:86

`Protected`createFunctionApp

createFunctionApp(resourceOptions?: ResourceOptions): void
Parameters
- OptionalresourceOptions: ResourceOptions
Returns void
Inherited from AzureFunctionApp.createFunctionApp
- Defined in packages/azure/src/construct/function-app/main.ts:363

`Protected`createFunctionAppSiteConfig

createFunctionAppSiteConfig(): void
Returns void
Overrides AzureFunctionApp.createFunctionAppSiteConfig
- Defined in packages/azure/src/construct/event-handler/main.ts:269

`Protected`createFunctionDashboard

createFunctionDashboard(): void
Returns void
Inherited from AzureFunctionApp.createFunctionDashboard
- Defined in packages/azure/src/construct/function-app/main.ts:528

`Protected`createFunctionHosts

createFunctionHosts(): void
Returns void
Inherited from AzureFunctionApp.createFunctionHosts
- Defined in packages/azure/src/construct/function-app/main.ts:327

`Protected`createResourceGroup

createResourceGroup(): void
Returns void
Inherited from AzureFunctionApp.createResourceGroup
- Defined in packages/azure/src/common/construct.ts:155

`Protected`createRoleAssignments

createRoleAssignments(): void
Returns void
Inherited from AzureFunctionApp.createRoleAssignments
- Defined in packages/azure/src/construct/function-app/main.ts:435

`Protected`createServiceBusDiagnosticLog

createServiceBusDiagnosticLog(): void
Returns void
- Defined in packages/azure/src/construct/event-handler/main.ts:226

`Protected`createServiceBusNamespace

createServiceBusNamespace(): void
Returns void
- Defined in packages/azure/src/construct/event-handler/main.ts:104

`Protected`createServiceBusQueue

createServiceBusQueue(): void
Returns void
- Defined in packages/azure/src/construct/event-handler/main.ts:131

`Protected`createStorageAccount

createStorageAccount(): void
Returns void
Inherited from AzureFunctionApp.createStorageAccount
- Defined in packages/azure/src/construct/function-app/main.ts:191

`Protected`createStorageContainer

createStorageContainer(): void
Returns void
Inherited from AzureFunctionApp.createStorageContainer
- Defined in packages/azure/src/construct/function-app/main.ts:217

`Protected`createStorageDeploymentContainer

createStorageDeploymentContainer(): void
Returns void
Inherited from AzureFunctionApp.createStorageDeploymentContainer
- Defined in packages/azure/src/construct/function-app/main.ts:202

`Protected`dashboardVariables

dashboardVariables(): Record<string, any>
Returns Record<string, any>
Overrides AzureFunctionApp.dashboardVariables
- Defined in packages/azure/src/construct/event-handler/main.ts:293

`Protected`determineFullyQualifiedDomain

determineFullyQualifiedDomain(): void
Returns void
Inherited from AzureFunctionApp.determineFullyQualifiedDomain
- Defined in packages/azure/src/common/construct.ts:186

`Protected`enableMalwareScanningOnDataStorageAccount

enableMalwareScanningOnDataStorageAccount(): void
Returns void
- Defined in packages/azure/src/construct/event-handler/main.ts:252

`Protected`generateStorageContainerSas

generateStorageContainerSas(): void
Returns void
Inherited from AzureFunctionApp.generateStorageContainerSas
- Defined in packages/azure/src/construct/function-app/main.ts:266

`Protected`getData

getData(): Promise<any>
Retrieves the data produces by initialize. The data is immediately available in a derived class's constructor after the super(...) call to ComponentResource.

Returns Promise<any>
Inherited from AzureFunctionApp.getData
- Defined in node_modules/.pnpm/@pulumi+pulumi@3.239.0_ts-node@10.9.2_@types+node@25.8.0_typescript@6.0.3__typescript@6.0.3/node_modules/@pulumi/pulumi/resource.d.ts:740

`Protected`getFunctionAppPrincipalId

getFunctionAppPrincipalId(): Output<string>
Returns Output<string>
Inherited from AzureFunctionApp.getFunctionAppPrincipalId
- Defined in packages/azure/src/construct/function-app/main.ts:428

getProvider

getProvider(moduleMember: string): ProviderResource | undefined
Returns the provider for the given module member, if one exists.
Parameters
- moduleMember: string
Returns ProviderResource | undefined
Inherited from AzureFunctionApp.getProvider
- Defined in node_modules/.pnpm/@pulumi+pulumi@3.239.0_ts-node@10.9.2_@types+node@25.8.0_typescript@6.0.3__typescript@6.0.3/node_modules/@pulumi/pulumi/resource.d.ts:43

`Protected`initialize

initialize(
    args: Inputs,
    opts?: ComponentResourceOptions,
    name?: string,
    type?: string,
): Promise<any>
Can be overridden by a subclass to asynchronously initialize data for this component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use getData.
Parameters
- args: Inputs
- Optionalopts: ComponentResourceOptions
- Optionalname: string
- Optionaltype: string
Returns Promise<any>
Inherited from AzureFunctionApp.initialize
- Defined in node_modules/.pnpm/@pulumi+pulumi@3.239.0_ts-node@10.9.2_@types+node@25.8.0_typescript@6.0.3__typescript@6.0.3/node_modules/@pulumi/pulumi/resource.d.ts:734

initResources

initResources(): void
Returns void
Overrides AzureFunctionApp.initResources
- Defined in packages/azure/src/construct/event-handler/main.ts:51

isDevelopmentStage

isDevelopmentStage(): boolean
Returns boolean
Inherited from AzureFunctionApp.isDevelopmentStage
- Defined in packages/azure/src/common/construct.ts:196

isProductionStage

isProductionStage(): boolean
Returns boolean
Inherited from AzureFunctionApp.isProductionStage
- Defined in packages/azure/src/common/construct.ts:214

isTestStage

isTestStage(): boolean
Returns boolean
Inherited from AzureFunctionApp.isTestStage
- Defined in packages/azure/src/common/construct.ts:202

isUatStage

isUatStage(): boolean
Returns boolean
Inherited from AzureFunctionApp.isUatStage
- Defined in packages/azure/src/common/construct.ts:208

`Protected`registerOutputs

registerOutputs(outputs?: Inputs | Promise<Inputs> | Output<Inputs>): void
Registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

Component resources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.
Parameters
- Optionaloutputs: Inputs | Promise<Inputs> | Output<Inputs>
Returns void
Inherited from AzureFunctionApp.registerOutputs
- Defined in node_modules/.pnpm/@pulumi+pulumi@3.239.0_ts-node@10.9.2_@types+node@25.8.0_typescript@6.0.3__typescript@6.0.3/node_modules/@pulumi/pulumi/resource.d.ts:751

`Protected`resolveApplicationInsights

resolveApplicationInsights(): void
Returns void
Inherited from AzureFunctionApp.resolveApplicationInsights
- Defined in packages/azure/src/construct/function-app/main.ts:135

`Protected`resolveCommonLogAnalyticsWorkspace

resolveCommonLogAnalyticsWorkspace(): void
Returns void
Inherited from AzureFunctionApp.resolveCommonLogAnalyticsWorkspace
- Defined in packages/azure/src/common/construct.ts:174

`Protected`resolveStack

resolveStack(id: string, stackName?: string): StackReference
Parameters
- id: string
  scoped id of the stack reference resource
- OptionalstackName: string
  optional fully qualified stack name; defaults to id if not provided
Returns StackReference
Inherited from AzureFunctionApp.resolveStack
- Defined in packages/azure/src/common/construct.ts:141

`Static`isInstance

isInstance(obj: any): obj is ComponentResource<any>
Returns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
Parameters
- obj: any
Returns obj is ComponentResource<any>
Inherited from AzureFunctionApp.isInstance
- Defined in node_modules/.pnpm/@pulumi+pulumi@3.239.0_ts-node@10.9.2_@types+node@25.8.0_typescript@6.0.3__typescript@6.0.3/node_modules/@pulumi/pulumi/resource.d.ts:703

Class AzureEventHandler

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AzureEventHandler

Properties

apiManagementManager

app

appCodeArchiveFile

appConfig

appConfigHash

OptionalappConfigPrefix

appConfigRoleAssignment

appConfigurationManager

appConfigurationsOriginalParsedConfig

appConfigurationsParsedConfig

appConnectionStrings

appDeploymentStorageContainer

appEnvironmentVariables

appKeyVaultsByResourceGroup

applicationInsights

applicationInsightsManager

appServiceManager

appServicePlan

appStorageAccount

appStorageContainer

authorisationManager

commonLogAnalyticsWorkspace

cosmosDbManager

dataKeyVault

dataStorageAccount

dataStorageContainer

dnsManager

eventGridEventSubscription

eventgridManager

eventGridRoleAssignment

eventGridTopic

fullyQualifiedDomainName

functionDashboard

functionManager

id

keyVaultManager

monitorManager

operationalInsightsManager

Optionaloptions

portalManager

props

redisManager

resourceGroup

resourceGroupManager

resourceNameFormatter

securityCentermanager

serviceBus

serviceBusManager

storageManager

storageRoleAssignment

Readonlyurn

Methods

ProtectedcreateAppConfiguration

Returns void

ProtectedcreateAppConfigurations

Returns void

ProtectedcreateAppServicePlan

Returns void

ProtectedcreateCodePackage

Returns void

ProtectedcreateDataStorageAccount

Returns void

ProtectedcreateDataStorageContainer

Returns void

ProtectedcreatedParsedAppConfigurations

Returns void

ProtectedcreateEventGrid

Returns void

`Optional`appConfigPrefix

`Optional`options

`Readonly`urn

`Protected`createAppConfiguration

`Protected`createAppConfigurations

`Protected`createAppServicePlan

`Protected`createCodePackage

`Protected`createDataStorageAccount

`Protected`createDataStorageContainer

`Protected`createdParsedAppConfigurations

`Protected`createEventGrid

`Protected`createEventGridEventSubscription

`Protected`createEventGridSubscriptionDlqStorageAccount

`Protected`createEventGridSubscriptionDlqStorageContainer

`Protected`createFunctionApp

`Protected`createFunctionAppSiteConfig

`Protected`createFunctionDashboard

`Protected`createFunctionHosts

`Protected`createResourceGroup

`Protected`createRoleAssignments

`Protected`createServiceBusDiagnosticLog

`Protected`createServiceBusNamespace

`Protected`createServiceBusQueue

`Protected`createStorageAccount

`Protected`createStorageContainer

`Protected`createStorageDeploymentContainer

`Protected`dashboardVariables

`Protected`determineFullyQualifiedDomain

`Protected`enableMalwareScanningOnDataStorageAccount

`Protected`generateStorageContainerSas

`Protected`getData

`Protected`getFunctionAppPrincipalId

`Protected`initialize

`Protected`registerOutputs

`Protected`resolveApplicationInsights

`Protected`resolveCommonLogAnalyticsWorkspace

`Protected`resolveStack

`Static`isInstance