GradientEdge CDK Utils
    Preparing search index...

    Interface FunctionAppProps

    interface FunctionAppProps {
        autoGeneratedDomainNameLabelScope?: Input<
            AutoGeneratedDomainNameLabelScope,
        >;
        clientAffinityEnabled?: Input<boolean>;
        clientAffinityPartitioningEnabled?: Input<boolean>;
        clientAffinityProxyEnabled?: Input<boolean>;
        clientCertEnabled?: Input<boolean>;
        clientCertExclusionPaths?: Input<string>;
        clientCertMode?: Input<ClientCertMode>;
        cloningInfo?: Input<CloningInfoArgs>;
        containerSize?: Input<number>;
        customDomainVerificationId?: Input<string>;
        dailyMemoryTimeQuota?: Input<number>;
        daprConfig?: Input<DaprConfigArgs>;
        dnsConfiguration?: Input<SiteDnsConfigArgs>;
        enabled?: Input<boolean>;
        endToEndEncryptionEnabled?: Input<boolean>;
        extendedLocation?: Input<ExtendedLocationArgs>;
        functionAppConfig?: Input<FunctionAppConfigArgs>;
        hostingEnvironmentProfile?: Input<HostingEnvironmentProfileArgs>;
        hostNamesDisabled?: Input<boolean>;
        hostNameSslStates?: Input<Input<HostNameSslStateArgs>[]>;
        httpsOnly?: Input<boolean>;
        hyperV?: Input<boolean>;
        identity?: Input<ManagedServiceIdentityArgs>;
        ipMode?: Input<IPMode>;
        isXenon?: Input<boolean>;
        keyVaultReferenceIdentity?: Input<string>;
        kind?: Input<string>;
        location?: Input<string>;
        managedEnvironmentId?: Input<string>;
        name?: string;
        outboundVnetRouting?: Input<OutboundVnetRoutingArgs>;
        publicNetworkAccess?: Input<string>;
        redundancyMode?: Input<RedundancyMode>;
        reserved?: Input<boolean>;
        resourceConfig?: Input<ResourceConfigArgs>;
        resourceGroupName: Input<string>;
        scmSiteAlsoStopped?: Input<boolean>;
        serverFarmId?: Input<string>;
        siteConfig?: Input<SiteConfigArgs>;
        sshEnabled?: Input<boolean>;
        storageAccountRequired?: Input<boolean>;
        tags?: Input<{ [key: string]: Input<string> }>;
        virtualNetworkSubnetId?: Input<string>;
        workloadProfileName?: Input<string>;
    }

    Hierarchy

    • WebAppArgs
      • FunctionAppProps
    Index

    Properties

    autoGeneratedDomainNameLabelScope? clientAffinityEnabled? clientAffinityPartitioningEnabled? clientAffinityProxyEnabled? clientCertEnabled? clientCertExclusionPaths? clientCertMode? cloningInfo? containerSize? customDomainVerificationId? dailyMemoryTimeQuota? daprConfig? dnsConfiguration? enabled? endToEndEncryptionEnabled? extendedLocation? functionAppConfig? hostingEnvironmentProfile? hostNamesDisabled? hostNameSslStates? httpsOnly? hyperV? identity? ipMode? isXenon? keyVaultReferenceIdentity? kind? location? managedEnvironmentId? name? outboundVnetRouting? publicNetworkAccess? redundancyMode? reserved? resourceConfig? resourceGroupName scmSiteAlsoStopped? serverFarmId? siteConfig? sshEnabled? storageAccountRequired? tags? virtualNetworkSubnetId? workloadProfileName?

    Properties

    autoGeneratedDomainNameLabelScope?: Input<AutoGeneratedDomainNameLabelScope>

    Specifies the scope of uniqueness for the default hostname during resource creation

    clientAffinityEnabled?: Input<boolean>

    true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.

    clientAffinityPartitioningEnabled?: Input<boolean>

    true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false.

    clientAffinityProxyEnabled?: Input<boolean>

    true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false.

    clientCertEnabled?: Input<boolean>

    true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

    clientCertExclusionPaths?: Input<string>

    client certificate authentication comma-separated exclusion paths

    clientCertMode?: Input<ClientCertMode>

    This composes with ClientCertEnabled setting.

    • ClientCertEnabled: false means ClientCert is ignored.
    • ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.
    • ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.
    cloningInfo?: Input<CloningInfoArgs>

    If specified during app creation, the app is cloned from a source app.

    containerSize?: Input<number>

    Size of the function container.

    customDomainVerificationId?: Input<string>

    Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

    dailyMemoryTimeQuota?: Input<number>

    Maximum allowed daily memory-time quota (applicable on dynamic apps only).

    daprConfig?: Input<DaprConfigArgs>

    Dapr configuration of the app.

    dnsConfiguration?: Input<SiteDnsConfigArgs>

    Property to configure various DNS related settings for a site.

    enabled?: Input<boolean>

    true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

    endToEndEncryptionEnabled?: Input<boolean>

    Whether to use end to end encryption between the FrontEnd and the Worker

    extendedLocation?: Input<ExtendedLocationArgs>

    Extended Location.

    functionAppConfig?: Input<FunctionAppConfigArgs>

    Configuration specific of the Azure Function app.

    hostingEnvironmentProfile?: Input<HostingEnvironmentProfileArgs>

    App Service Environment to use for the app.

    hostNamesDisabled?: Input<boolean>

    true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

    hostNameSslStates?: Input<Input<HostNameSslStateArgs>[]>

    Hostname SSL states are used to manage the SSL bindings for app's hostnames.

    httpsOnly?: Input<boolean>

    HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

    hyperV?: Input<boolean>

    Hyper-V sandbox.

    identity?: Input<ManagedServiceIdentityArgs>

    Managed service identity.

    ipMode?: Input<IPMode>

    Specifies the IP mode of the app.

    isXenon?: Input<boolean>

    Obsolete: Hyper-V sandbox.

    keyVaultReferenceIdentity?: Input<string>

    Identity to use for Key Vault Reference authentication.

    kind?: Input<string>

    Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.

    location?: Input<string>

    Resource Location.

    managedEnvironmentId?: Input<string>

    Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}

    name?: string

    Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.

    outboundVnetRouting?: Input<OutboundVnetRoutingArgs>

    Property to configure various outbound traffic routing options over virtual network for a site

    publicNetworkAccess?: Input<string>

    Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.

    redundancyMode?: Input<RedundancyMode>

    Site redundancy mode

    reserved?: Input<boolean>

    true if reserved; otherwise, false.

    resourceConfig?: Input<ResourceConfigArgs>

    Function app resource requirements.

    resourceGroupName: Input<string>

    Name of the resource group to which the resource belongs.

    scmSiteAlsoStopped?: Input<boolean>

    true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

    serverFarmId?: Input<string>

    Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

    siteConfig?: Input<SiteConfigArgs>

    Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information.

    sshEnabled?: Input<boolean>

    Whether to enable ssh access.

    storageAccountRequired?: Input<boolean>

    Checks if Customer provided storage account is required

    tags?: Input<{ [key: string]: Input<string> }>

    Resource tags.

    virtualNetworkSubnetId?: Input<string>

    Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

    workloadProfileName?: Input<string>

    Workload profile name for function app to execute on.

    Settings

    Member Visibility

    On This Page

    Properties