GradientEdge CDK Utils
    Preparing search index...

    Interface AzureRestApiProps

    Properties for the AzureRestApi construct

    interface AzureRestApiProps {
        apiAuthKeyVault: ApiAuthKeyVault;
        apiManagement: ApiManagementProps;
        apiManagementDiagnostic: ApiDiagnosticProps;
        apiManagementDiagnosticSettings: MonitorDiagnosticSettingProps;
        clientId?: string;
        clientSecret?: string;
        commonApplicationInsights?: GetComponentOutputArgs;
        commonLogAnalyticsWorkspace?: GetWorkspaceOutputArgs;
        debug?: boolean;
        defaultTags?: { [key: string]: string };
        domainName: string;
        environment?: string;
        extraContexts?: string[];
        globalPrefix?: string;
        globalSuffix?: string;
        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;
        useMsi?: boolean;
        useOidc?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiAuthKeyVault apiManagement apiManagementDiagnostic apiManagementDiagnosticSettings clientId? clientSecret? commonApplicationInsights? commonLogAnalyticsWorkspace? debug? defaultTags? domainName environment? extraContexts? globalPrefix? globalSuffix? locales? location locationConfig? msiEndpoint? name oidcRequestToken? oidcRequestUrl? regionContextPath? remoteBackend? resourceGroupName? resourceNameOptions? resourcePrefix? resourceSuffix? skipStageForARecords? stackName? stage stageContextPath? stageRegionContextPath? subDomain? subscriptionId? tenantId? useMsi? useOidc?

    Properties

    apiAuthKeyVault: ApiAuthKeyVault

    Key Vault reference for API authentication secrets

    apiManagement: ApiManagementProps

    API Management service properties

    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

    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')

    extraContexts?: string[]

    Additional CDK context file paths to load

    globalPrefix?: string

    Global prefix applied to all resource names

    globalSuffix?: string

    Global suffix applied to all resource names

    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

    useMsi?: boolean

    Enable Managed Service Identity (MSI) authentication

    useOidc?: boolean

    Enable OpenID Connect (OIDC) authentication

    Settings

    Member Visibility

    On This Page

    Properties