GradientEdge CDK Utils
    Preparing search index...

    Interface AzureRestApiFunctionProps

    Properties for the AzureRestApiFunction construct

    interface AzureRestApiFunctionProps {
        apiAuthKeyVault: ApiAuthKeyVault;
        apiManagement: ApiManagementRestApiProps;
        apiManagementApi: ApiManagementApiProps;
        apiManagementApplicationInsights?: ApplicationInsightsProps;
        apiManagementBackend: ApiManagementBackendProps;
        apiManagementCors?: ApiManagementCors;
        apiManagementDiagnostic: ApiDiagnosticProps;
        apiManagementDiagnosticSettings: MonitorDiagnosticSettingProps;
        clientId?: string;
        clientSecret?: string;
        commonApplicationInsights?: GetComponentOutputArgs;
        commonLogAnalyticsWorkspace?: GetWorkspaceOutputArgs;
        dataKeyVaultName: string;
        dataKeyVaultSecretName: string;
        dataStorageAccount: StorageAccountProps;
        dataStorageContainer: StorageContainerProps;
        dataStorageContainerSas: ContainerSasTokenProps;
        debug?: boolean;
        defaultTags?: { [key: string]: string };
        domainName: string;
        environment?: string;
        existingConfigStoreName: string;
        existingConfigStoreResourceGroupName: string;
        existingCosmosAccountName: string;
        existingCosmosAccountResourceGroupName: string;
        existingTopicName: string;
        existingTopicResourceGroupName: string;
        extraContexts?: string[];
        functionApp: FunctionAppProperties;
        globalPrefix?: string;
        globalSuffix?: string;
        hostsConfiguration: any;
        locales?: string[];
        location: AzureLocation;
        locationConfig?: Record<AzureLocation, AzureLocationConfig>;
        msiEndpoint?: string;
        name: string;
        oidcRequestToken?: string;
        oidcRequestUrl?: string;
        regionContextPath?: string;
        remoteBackend?: AzureRemoteBackendProps;
        resourceGroupName?: string;
        resourceNameOptions?: { [key: string]: AzureResourceNameFormatterProps };
        resourcePrefix?: string;
        resourceSuffix?: string;
        skipStageForARecords?: boolean;
        stackName?: string;
        stage: string;
        stageContextPath?: string;
        stageRegionContextPath?: string;
        subDomain?: string;
        subscriptionId?: string;
        tenantId?: string;
        useConfigOverride?: boolean;
        useMsi?: boolean;
        useOidc?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiAuthKeyVault apiManagement apiManagementApi apiManagementApplicationInsights? apiManagementBackend apiManagementCors? apiManagementDiagnostic apiManagementDiagnosticSettings clientId? clientSecret? commonApplicationInsights? commonLogAnalyticsWorkspace? dataKeyVaultName dataKeyVaultSecretName dataStorageAccount dataStorageContainer dataStorageContainerSas debug? defaultTags? domainName environment? existingConfigStoreName existingConfigStoreResourceGroupName existingCosmosAccountName existingCosmosAccountResourceGroupName existingTopicName existingTopicResourceGroupName extraContexts? functionApp globalPrefix? globalSuffix? hostsConfiguration locales? location locationConfig? msiEndpoint? name oidcRequestToken? oidcRequestUrl? regionContextPath? remoteBackend? resourceGroupName? resourceNameOptions? resourcePrefix? resourceSuffix? skipStageForARecords? stackName? stage stageContextPath? stageRegionContextPath? subDomain? subscriptionId? tenantId? useConfigOverride? useMsi? useOidc?

    Properties

    apiAuthKeyVault: ApiAuthKeyVault

    Key Vault reference for API authentication secrets

    apiManagement: ApiManagementRestApiProps

    API Management service properties with existing service resolution

    apiManagementApi: ApiManagementApiProps

    API configuration including operations and policies

    apiManagementApplicationInsights?: ApplicationInsightsProps

    Optional Application Insights properties for API-level monitoring

    apiManagementBackend: ApiManagementBackendProps

    Backend configuration for routing to the function app

    apiManagementCors?: ApiManagementCors

    Optional CORS policy configuration

    apiManagementDiagnostic: ApiDiagnosticProps

    API diagnostic properties for logging

    apiManagementDiagnosticSettings: MonitorDiagnosticSettingProps

    Monitor diagnostic settings for the API Management service

    clientId?: string

    Service principal client ID for authentication

    clientSecret?: string

    Service principal client secret for authentication

    commonApplicationInsights?: GetComponentOutputArgs

    Shared Application Insights component lookup arguments for telemetry

    commonLogAnalyticsWorkspace?: GetWorkspaceOutputArgs

    Shared Log Analytics Workspace lookup arguments for diagnostic logging

    dataKeyVaultName: string

    Name of the Key Vault for storing the data SAS token

    dataKeyVaultSecretName: string

    Name of the Key Vault secret for the data SAS token

    dataStorageAccount: StorageAccountProps

    Data storage account properties for the function app

    dataStorageContainer: StorageContainerProps

    Data storage container properties for the function app

    dataStorageContainerSas: ContainerSasTokenProps

    SAS token properties for the data storage container

    debug?: boolean

    Enable debug logging output

    defaultTags?: { [key: string]: string }

    Default tags applied to all taggable Azure resources

    domainName: string

    The root domain name for the deployment

    environment?: string

    Azure cloud environment (e.g. 'public', 'usgovernment')

    existingConfigStoreName: string

    Name of the existing App Configuration store

    existingConfigStoreResourceGroupName: string

    Resource group name of the existing App Configuration store

    existingCosmosAccountName: string

    Name of the existing CosmosDB account

    existingCosmosAccountResourceGroupName: string

    Resource group name of the existing CosmosDB account

    existingTopicName: string

    Name of the existing EventGrid topic for event publishing

    existingTopicResourceGroupName: string

    Resource group name of the existing EventGrid topic

    extraContexts?: string[]

    Additional CDK context file paths to load

    functionApp: FunctionAppProperties

    Function app resource properties

    globalPrefix?: string

    Global prefix applied to all resource names

    globalSuffix?: string

    Global suffix applied to all resource names

    hostsConfiguration: any

    Custom host.json configuration to merge at the stack level

    locales?: string[]

    List of supported locales for the deployment

    location: AzureLocation

    Primary Azure region for resource deployment

    locationConfig?: Record<AzureLocation, AzureLocationConfig>

    Location configuration map for multi-region deployments

    msiEndpoint?: string

    Custom MSI endpoint URL

    name: string

    The name identifier for the stack or construct

    oidcRequestToken?: string

    OIDC request token for federated identity

    oidcRequestUrl?: string

    OIDC request URL for federated identity

    regionContextPath?: string

    The relative path to region-specific context files

    remoteBackend?: AzureRemoteBackendProps

    Remote backend configuration for Pulumi state storage

    resourceGroupName?: string

    Optional Azure resource group name override

    resourceNameOptions?: { [key: string]: AzureResourceNameFormatterProps }

    Per-resource naming options keyed by resource type identifier

    resourcePrefix?: string

    Prefix applied to individual resource names

    resourceSuffix?: string

    Suffix applied to individual resource names

    skipStageForARecords?: boolean

    Whether to omit the stage prefix for Route53 A records

    stackName?: string

    Optional Pulumi stack name for cross-stack references

    stage: string

    The deployment stage (e.g. dev, tst, uat, prd)

    stageContextPath?: string

    The relative path to stage-specific context files

    stageRegionContextPath?: string

    The relative path to stage-region-specific context files

    subDomain?: string

    The subdomain prefix for the deployment

    subscriptionId?: string

    Azure subscription ID for the deployment

    tenantId?: string

    Azure Active Directory tenant ID

    useConfigOverride?: boolean

    When true, bypasses App Configuration store and uses config overrides

    useMsi?: boolean

    Enable Managed Service Identity (MSI) authentication

    useOidc?: boolean

    Enable OpenID Connect (OIDC) authentication

    Settings

    Member Visibility

    On This Page

    Properties
    apiAuthKeyVaultapiManagementapiManagementApiapiManagementApplicationInsightsapiManagementBackendapiManagementCorsapiManagementDiagnosticapiManagementDiagnosticSettingsclientIdclientSecretcommonApplicationInsightscommonLogAnalyticsWorkspacedataKeyVaultNamedataKeyVaultSecretNamedataStorageAccountdataStorageContainerdataStorageContainerSasdebugdefaultTagsdomainNameenvironmentexistingConfigStoreNameexistingConfigStoreResourceGroupNameexistingCosmosAccountNameexistingCosmosAccountResourceGroupNameexistingTopicNameexistingTopicResourceGroupNameextraContextsfunctionAppglobalPrefixglobalSuffixhostsConfigurationlocaleslocationlocationConfigmsiEndpointnameoidcRequestTokenoidcRequestUrlregionContextPathremoteBackendresourceGroupNameresourceNameOptionsresourcePrefixresourceSuffixskipStageForARecordsstackNamestagestageContextPathstageRegionContextPathsubDomainsubscriptionIdtenantIduseConfigOverrideuseMsiuseOidc