Azure v6.22.0, Apr 1 25

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.appservice.getFunctionApp

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.appservice.getFunctionApp({
    name: "test-azure-functions",
    resourceGroupName: exampleAzurermResourceGroup.name,
});

import pulumi
import pulumi_azure as azure

example = azure.appservice.get_function_app(name="test-azure-functions",
    resource_group_name=example_azurerm_resource_group["name"])

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appservice"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appservice.LookupFunctionApp(ctx, &appservice.LookupFunctionAppArgs{
			Name:              "test-azure-functions",
			ResourceGroupName: exampleAzurermResourceGroup.Name,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.AppService.GetFunctionApp.Invoke(new()
    {
        Name = "test-azure-functions",
        ResourceGroupName = exampleAzurermResourceGroup.Name,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.appservice.AppserviceFunctions;
import com.pulumi.azure.appservice.inputs.GetFunctionAppArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = AppserviceFunctions.getFunctionApp(GetFunctionAppArgs.builder()
            .name("test-azure-functions")
            .resourceGroupName(exampleAzurermResourceGroup.name())
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: azure:appservice:getFunctionApp
      arguments:
        name: test-azure-functions
        resourceGroupName: ${exampleAzurermResourceGroup.name}

Using getFunctionApp

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getFunctionApp(args: GetFunctionAppArgs, opts?: InvokeOptions): Promise<GetFunctionAppResult>
function getFunctionAppOutput(args: GetFunctionAppOutputArgs, opts?: InvokeOptions): Output<GetFunctionAppResult>

def get_function_app(name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     opts: Optional[InvokeOptions] = None) -> GetFunctionAppResult
def get_function_app_output(name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetFunctionAppResult]

func LookupFunctionApp(ctx *Context, args *LookupFunctionAppArgs, opts ...InvokeOption) (*LookupFunctionAppResult, error)
func LookupFunctionAppOutput(ctx *Context, args *LookupFunctionAppOutputArgs, opts ...InvokeOption) LookupFunctionAppResultOutput

> Note: This function is named LookupFunctionApp in the Go SDK.

public static class GetFunctionApp 
{
    public static Task<GetFunctionAppResult> InvokeAsync(GetFunctionAppArgs args, InvokeOptions? opts = null)
    public static Output<GetFunctionAppResult> Invoke(GetFunctionAppInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFunctionAppResult> getFunctionApp(GetFunctionAppArgs args, InvokeOptions options)
public static Output<GetFunctionAppResult> getFunctionApp(GetFunctionAppArgs args, InvokeOptions options)

fn::invoke:
  function: azure:appservice/getFunctionApp:getFunctionApp
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the Function App resource.
ResourceGroupName string: The name of the Resource Group where the Function App exists.
Tags Dictionary<string, string>

Name string: The name of the Function App resource.
ResourceGroupName string: The name of the Resource Group where the Function App exists.
Tags map[string]string

name String: The name of the Function App resource.
resourceGroupName String: The name of the Resource Group where the Function App exists.
tags Map<String,String>

name string: The name of the Function App resource.
resourceGroupName string: The name of the Resource Group where the Function App exists.
tags {[key: string]: string}

name str: The name of the Function App resource.
resource_group_name str: The name of the Resource Group where the Function App exists.
tags Mapping[str, str]

name String: The name of the Function App resource.
resourceGroupName String: The name of the Resource Group where the Function App exists.
tags Map<String>

getFunctionApp Result

The following output properties are available:

AppServicePlanId string: The ID of the App Service Plan within which to create this Function App.
AppSettings Dictionary<string, string>: A key-value pair of App Settings.
ClientCertMode string: The mode of the Function App's client certificates requirement for incoming requests.
ConnectionStrings List<GetFunctionAppConnectionString>: An connection_string block as defined below.
CustomDomainVerificationId string: An identifier used by App Service to perform domain ownership verification via DNS TXT record.
DefaultHostname string: The default hostname associated with the Function App.
Enabled bool: Is the Function App enabled?
Id string: The provider-assigned unique ID for this managed resource.
Identities List<GetFunctionAppIdentity>: A identity block as defined below.
Location string
Name string: The name for this IP Restriction.
OsType string: A string indicating the Operating System type for this function app.
OutboundIpAddresses string: A comma separated list of outbound IP addresses.
PossibleOutboundIpAddresses string: A comma separated list of outbound IP addresses, not all of which are necessarily in use. Superset of outbound_ip_addresses.
ResourceGroupName string
SiteConfigs List<GetFunctionAppSiteConfig>
SiteCredentials List<GetFunctionAppSiteCredential>: A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.
SourceControls List<GetFunctionAppSourceControl>: A source_control block as defined below.
Tags Dictionary<string, string>

AppServicePlanId string: The ID of the App Service Plan within which to create this Function App.
AppSettings map[string]string: A key-value pair of App Settings.
ClientCertMode string: The mode of the Function App's client certificates requirement for incoming requests.
ConnectionStrings []GetFunctionAppConnectionString: An connection_string block as defined below.
CustomDomainVerificationId string: An identifier used by App Service to perform domain ownership verification via DNS TXT record.
DefaultHostname string: The default hostname associated with the Function App.
Enabled bool: Is the Function App enabled?
Id string: The provider-assigned unique ID for this managed resource.
Identities []GetFunctionAppIdentity: A identity block as defined below.
Location string
Name string: The name for this IP Restriction.
OsType string: A string indicating the Operating System type for this function app.
OutboundIpAddresses string: A comma separated list of outbound IP addresses.
PossibleOutboundIpAddresses string: A comma separated list of outbound IP addresses, not all of which are necessarily in use. Superset of outbound_ip_addresses.
ResourceGroupName string
SiteConfigs []GetFunctionAppSiteConfig
SiteCredentials []GetFunctionAppSiteCredential: A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.
SourceControls []GetFunctionAppSourceControl: A source_control block as defined below.
Tags map[string]string

appServicePlanId String: The ID of the App Service Plan within which to create this Function App.
appSettings Map<String,String>: A key-value pair of App Settings.
clientCertMode String: The mode of the Function App's client certificates requirement for incoming requests.
connectionStrings List<GetFunctionAppConnectionString>: An connection_string block as defined below.
customDomainVerificationId String: An identifier used by App Service to perform domain ownership verification via DNS TXT record.
defaultHostname String: The default hostname associated with the Function App.
enabled Boolean: Is the Function App enabled?
id String: The provider-assigned unique ID for this managed resource.
identities List<GetFunctionAppIdentity>: A identity block as defined below.
location String
name String: The name for this IP Restriction.
osType String: A string indicating the Operating System type for this function app.
outboundIpAddresses String: A comma separated list of outbound IP addresses.
possibleOutboundIpAddresses String: A comma separated list of outbound IP addresses, not all of which are necessarily in use. Superset of outbound_ip_addresses.
resourceGroupName String
siteConfigs List<GetFunctionAppSiteConfig>
siteCredentials List<GetFunctionAppSiteCredential>: A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.
sourceControls List<GetFunctionAppSourceControl>: A source_control block as defined below.
tags Map<String,String>

appServicePlanId string: The ID of the App Service Plan within which to create this Function App.
appSettings {[key: string]: string}: A key-value pair of App Settings.
clientCertMode string: The mode of the Function App's client certificates requirement for incoming requests.
connectionStrings GetFunctionAppConnectionString[]: An connection_string block as defined below.
customDomainVerificationId string: An identifier used by App Service to perform domain ownership verification via DNS TXT record.
defaultHostname string: The default hostname associated with the Function App.
enabled boolean: Is the Function App enabled?
id string: The provider-assigned unique ID for this managed resource.
identities GetFunctionAppIdentity[]: A identity block as defined below.
location string
name string: The name for this IP Restriction.
osType string: A string indicating the Operating System type for this function app.
outboundIpAddresses string: A comma separated list of outbound IP addresses.
possibleOutboundIpAddresses string: A comma separated list of outbound IP addresses, not all of which are necessarily in use. Superset of outbound_ip_addresses.
resourceGroupName string
siteConfigs GetFunctionAppSiteConfig[]
siteCredentials GetFunctionAppSiteCredential[]: A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.
sourceControls GetFunctionAppSourceControl[]: A source_control block as defined below.
tags {[key: string]: string}

app_service_plan_id str: The ID of the App Service Plan within which to create this Function App.
app_settings Mapping[str, str]: A key-value pair of App Settings.
client_cert_mode str: The mode of the Function App's client certificates requirement for incoming requests.
connection_strings Sequence[GetFunctionAppConnectionString]: An connection_string block as defined below.
custom_domain_verification_id str: An identifier used by App Service to perform domain ownership verification via DNS TXT record.
default_hostname str: The default hostname associated with the Function App.
enabled bool: Is the Function App enabled?
id str: The provider-assigned unique ID for this managed resource.
identities Sequence[GetFunctionAppIdentity]: A identity block as defined below.
location str
name str: The name for this IP Restriction.
os_type str: A string indicating the Operating System type for this function app.
outbound_ip_addresses str: A comma separated list of outbound IP addresses.
possible_outbound_ip_addresses str: A comma separated list of outbound IP addresses, not all of which are necessarily in use. Superset of outbound_ip_addresses.
resource_group_name str
site_configs Sequence[GetFunctionAppSiteConfig]
site_credentials Sequence[GetFunctionAppSiteCredential]: A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.
source_controls Sequence[GetFunctionAppSourceControl]: A source_control block as defined below.
tags Mapping[str, str]

appServicePlanId String: The ID of the App Service Plan within which to create this Function App.
appSettings Map<String>: A key-value pair of App Settings.
clientCertMode String: The mode of the Function App's client certificates requirement for incoming requests.
connectionStrings List<Property Map>: An connection_string block as defined below.
customDomainVerificationId String: An identifier used by App Service to perform domain ownership verification via DNS TXT record.
defaultHostname String: The default hostname associated with the Function App.
enabled Boolean: Is the Function App enabled?
id String: The provider-assigned unique ID for this managed resource.
identities List<Property Map>: A identity block as defined below.
location String
name String: The name for this IP Restriction.
osType String: A string indicating the Operating System type for this function app.
outboundIpAddresses String: A comma separated list of outbound IP addresses.
possibleOutboundIpAddresses String: A comma separated list of outbound IP addresses, not all of which are necessarily in use. Superset of outbound_ip_addresses.
resourceGroupName String
siteConfigs List<Property Map>
siteCredentials List<Property Map>: A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.
sourceControls List<Property Map>: A source_control block as defined below.
tags Map<String>

Supporting Types

GetFunctionAppConnectionString

Name string: The name of the Function App resource.
Type string: The identity type of the Managed Identity assigned to the Function App.
Value string: The value for the Connection String.

Name string: The name of the Function App resource.
Type string: The identity type of the Managed Identity assigned to the Function App.
Value string: The value for the Connection String.

name String: The name of the Function App resource.
type String: The identity type of the Managed Identity assigned to the Function App.
value String: The value for the Connection String.

name string: The name of the Function App resource.
type string: The identity type of the Managed Identity assigned to the Function App.
value string: The value for the Connection String.

name str: The name of the Function App resource.
type str: The identity type of the Managed Identity assigned to the Function App.
value str: The value for the Connection String.

name String: The name of the Function App resource.
type String: The identity type of the Managed Identity assigned to the Function App.
value String: The value for the Connection String.

GetFunctionAppIdentity

IdentityIds List<string>: A list of User Assigned Identity IDs assigned to the Function App.
PrincipalId string: The ID of the Managed Identity assigned to the Function App.
TenantId string: The ID of the Tenant where the Managed Identity assigned to the Function App is located.
Type string: The identity type of the Managed Identity assigned to the Function App.

IdentityIds []string: A list of User Assigned Identity IDs assigned to the Function App.
PrincipalId string: The ID of the Managed Identity assigned to the Function App.
TenantId string: The ID of the Tenant where the Managed Identity assigned to the Function App is located.
Type string: The identity type of the Managed Identity assigned to the Function App.

identityIds List<String>: A list of User Assigned Identity IDs assigned to the Function App.
principalId String: The ID of the Managed Identity assigned to the Function App.
tenantId String: The ID of the Tenant where the Managed Identity assigned to the Function App is located.
type String: The identity type of the Managed Identity assigned to the Function App.

identityIds string[]: A list of User Assigned Identity IDs assigned to the Function App.
principalId string: The ID of the Managed Identity assigned to the Function App.
tenantId string: The ID of the Tenant where the Managed Identity assigned to the Function App is located.
type string: The identity type of the Managed Identity assigned to the Function App.

identity_ids Sequence[str]: A list of User Assigned Identity IDs assigned to the Function App.
principal_id str: The ID of the Managed Identity assigned to the Function App.
tenant_id str: The ID of the Tenant where the Managed Identity assigned to the Function App is located.
type str: The identity type of the Managed Identity assigned to the Function App.

identityIds List<String>: A list of User Assigned Identity IDs assigned to the Function App.
principalId String: The ID of the Managed Identity assigned to the Function App.
tenantId String: The ID of the Tenant where the Managed Identity assigned to the Function App is located.
type String: The identity type of the Managed Identity assigned to the Function App.

GetFunctionAppSiteConfig

AlwaysOn bool: Is the app loaded at all times?
AppScaleLimit int: The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
AutoSwapSlotName string
Cors GetFunctionAppSiteConfigCors: A cors block as defined above.
DotnetFrameworkVersion string: The version of the .NET framework's CLR used in this App Service.
ElasticInstanceMinimum int: The number of minimum instances for this function app. Only applicable to apps on the Premium plan.
FtpsState string: State of FTP / FTPS service for this AppService.
HealthCheckPath string
Http2Enabled bool: Is HTTP2 Enabled on this App Service?
IpRestrictions List<GetFunctionAppSiteConfigIpRestriction>: One or more ip_restriction blocks as defined above.
JavaVersion string: Java version hosted by the function app in Azure.
LinuxFxVersion string: Linux App Framework and version for the AppService.
MinTlsVersion string: The minimum supported TLS version for this App Service.
PreWarmedInstanceCount int: The number of pre-warmed instances for this function app. Only applicable to apps on the Premium plan.
RuntimeScaleMonitoringEnabled bool: Is Runtime Scale Monitoring Enabled on this function app?
ScmIpRestrictions List<GetFunctionAppSiteConfigScmIpRestriction>: One or more scm_ip_restriction blocks as defined above.
ScmType string: The type of Source Control enabled for this App Service.
ScmUseMainIpRestriction bool: IP security restrictions for scm to use main.
Use32BitWorkerProcess bool: Does the App Service run in 32 bit mode, rather than 64 bit mode?
VnetRouteAllEnabled bool: (Optional) Should all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied?
WebsocketsEnabled bool: Are WebSockets enabled for this App Service?

AlwaysOn bool: Is the app loaded at all times?
AppScaleLimit int: The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
AutoSwapSlotName string
Cors GetFunctionAppSiteConfigCors: A cors block as defined above.
DotnetFrameworkVersion string: The version of the .NET framework's CLR used in this App Service.
ElasticInstanceMinimum int: The number of minimum instances for this function app. Only applicable to apps on the Premium plan.
FtpsState string: State of FTP / FTPS service for this AppService.
HealthCheckPath string
Http2Enabled bool: Is HTTP2 Enabled on this App Service?
IpRestrictions []GetFunctionAppSiteConfigIpRestriction: One or more ip_restriction blocks as defined above.
JavaVersion string: Java version hosted by the function app in Azure.
LinuxFxVersion string: Linux App Framework and version for the AppService.
MinTlsVersion string: The minimum supported TLS version for this App Service.
PreWarmedInstanceCount int: The number of pre-warmed instances for this function app. Only applicable to apps on the Premium plan.
RuntimeScaleMonitoringEnabled bool: Is Runtime Scale Monitoring Enabled on this function app?
ScmIpRestrictions []GetFunctionAppSiteConfigScmIpRestriction: One or more scm_ip_restriction blocks as defined above.
ScmType string: The type of Source Control enabled for this App Service.
ScmUseMainIpRestriction bool: IP security restrictions for scm to use main.
Use32BitWorkerProcess bool: Does the App Service run in 32 bit mode, rather than 64 bit mode?
VnetRouteAllEnabled bool: (Optional) Should all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied?
WebsocketsEnabled bool: Are WebSockets enabled for this App Service?

alwaysOn Boolean: Is the app loaded at all times?
appScaleLimit Integer: The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
autoSwapSlotName String
cors GetFunctionAppSiteConfigCors: A cors block as defined above.
dotnetFrameworkVersion String: The version of the .NET framework's CLR used in this App Service.
elasticInstanceMinimum Integer: The number of minimum instances for this function app. Only applicable to apps on the Premium plan.
ftpsState String: State of FTP / FTPS service for this AppService.
healthCheckPath String
http2Enabled Boolean: Is HTTP2 Enabled on this App Service?
ipRestrictions List<GetFunctionAppSiteConfigIpRestriction>: One or more ip_restriction blocks as defined above.
javaVersion String: Java version hosted by the function app in Azure.
linuxFxVersion String: Linux App Framework and version for the AppService.
minTlsVersion String: The minimum supported TLS version for this App Service.
preWarmedInstanceCount Integer: The number of pre-warmed instances for this function app. Only applicable to apps on the Premium plan.
runtimeScaleMonitoringEnabled Boolean: Is Runtime Scale Monitoring Enabled on this function app?
scmIpRestrictions List<GetFunctionAppSiteConfigScmIpRestriction>: One or more scm_ip_restriction blocks as defined above.
scmType String: The type of Source Control enabled for this App Service.
scmUseMainIpRestriction Boolean: IP security restrictions for scm to use main.
use32BitWorkerProcess Boolean: Does the App Service run in 32 bit mode, rather than 64 bit mode?
vnetRouteAllEnabled Boolean: (Optional) Should all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied?
websocketsEnabled Boolean: Are WebSockets enabled for this App Service?

alwaysOn boolean: Is the app loaded at all times?
appScaleLimit number: The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
autoSwapSlotName string
cors GetFunctionAppSiteConfigCors: A cors block as defined above.
dotnetFrameworkVersion string: The version of the .NET framework's CLR used in this App Service.
elasticInstanceMinimum number: The number of minimum instances for this function app. Only applicable to apps on the Premium plan.
ftpsState string: State of FTP / FTPS service for this AppService.
healthCheckPath string
http2Enabled boolean: Is HTTP2 Enabled on this App Service?
ipRestrictions GetFunctionAppSiteConfigIpRestriction[]: One or more ip_restriction blocks as defined above.
javaVersion string: Java version hosted by the function app in Azure.
linuxFxVersion string: Linux App Framework and version for the AppService.
minTlsVersion string: The minimum supported TLS version for this App Service.
preWarmedInstanceCount number: The number of pre-warmed instances for this function app. Only applicable to apps on the Premium plan.
runtimeScaleMonitoringEnabled boolean: Is Runtime Scale Monitoring Enabled on this function app?
scmIpRestrictions GetFunctionAppSiteConfigScmIpRestriction[]: One or more scm_ip_restriction blocks as defined above.
scmType string: The type of Source Control enabled for this App Service.
scmUseMainIpRestriction boolean: IP security restrictions for scm to use main.
use32BitWorkerProcess boolean: Does the App Service run in 32 bit mode, rather than 64 bit mode?
vnetRouteAllEnabled boolean: (Optional) Should all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied?
websocketsEnabled boolean: Are WebSockets enabled for this App Service?

always_on bool: Is the app loaded at all times?
app_scale_limit int: The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
auto_swap_slot_name str
cors GetFunctionAppSiteConfigCors: A cors block as defined above.
dotnet_framework_version str: The version of the .NET framework's CLR used in this App Service.
elastic_instance_minimum int: The number of minimum instances for this function app. Only applicable to apps on the Premium plan.
ftps_state str: State of FTP / FTPS service for this AppService.
health_check_path str
http2_enabled bool: Is HTTP2 Enabled on this App Service?
ip_restrictions Sequence[GetFunctionAppSiteConfigIpRestriction]: One or more ip_restriction blocks as defined above.
java_version str: Java version hosted by the function app in Azure.
linux_fx_version str: Linux App Framework and version for the AppService.
min_tls_version str: The minimum supported TLS version for this App Service.
pre_warmed_instance_count int: The number of pre-warmed instances for this function app. Only applicable to apps on the Premium plan.
runtime_scale_monitoring_enabled bool: Is Runtime Scale Monitoring Enabled on this function app?
scm_ip_restrictions Sequence[GetFunctionAppSiteConfigScmIpRestriction]: One or more scm_ip_restriction blocks as defined above.
scm_type str: The type of Source Control enabled for this App Service.
scm_use_main_ip_restriction bool: IP security restrictions for scm to use main.
use32_bit_worker_process bool: Does the App Service run in 32 bit mode, rather than 64 bit mode?
vnet_route_all_enabled bool: (Optional) Should all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied?
websockets_enabled bool: Are WebSockets enabled for this App Service?

alwaysOn Boolean: Is the app loaded at all times?
appScaleLimit Number: The number of workers this function app can scale out to. Only applicable to apps on the Consumption and Premium plan.
autoSwapSlotName String
cors Property Map: A cors block as defined above.
dotnetFrameworkVersion String: The version of the .NET framework's CLR used in this App Service.
elasticInstanceMinimum Number: The number of minimum instances for this function app. Only applicable to apps on the Premium plan.
ftpsState String: State of FTP / FTPS service for this AppService.
healthCheckPath String
http2Enabled Boolean: Is HTTP2 Enabled on this App Service?
ipRestrictions List<Property Map>: One or more ip_restriction blocks as defined above.
javaVersion String: Java version hosted by the function app in Azure.
linuxFxVersion String: Linux App Framework and version for the AppService.
minTlsVersion String: The minimum supported TLS version for this App Service.
preWarmedInstanceCount Number: The number of pre-warmed instances for this function app. Only applicable to apps on the Premium plan.
runtimeScaleMonitoringEnabled Boolean: Is Runtime Scale Monitoring Enabled on this function app?
scmIpRestrictions List<Property Map>: One or more scm_ip_restriction blocks as defined above.
scmType String: The type of Source Control enabled for this App Service.
scmUseMainIpRestriction Boolean: IP security restrictions for scm to use main.
use32BitWorkerProcess Boolean: Does the App Service run in 32 bit mode, rather than 64 bit mode?
vnetRouteAllEnabled Boolean: (Optional) Should all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied?
websocketsEnabled Boolean: Are WebSockets enabled for this App Service?

GetFunctionAppSiteConfigCors

AllowedOrigins List<string>
SupportCredentials bool

AllowedOrigins []string
SupportCredentials bool

allowedOrigins List<String>
supportCredentials Boolean

allowedOrigins string[]
supportCredentials boolean

allowed_origins Sequence[str]
support_credentials bool

allowedOrigins List<String>
supportCredentials Boolean

GetFunctionAppSiteConfigIpRestriction

Action string: Allow or Deny access for this IP range. Defaults to Allow.
Headers GetFunctionAppSiteConfigIpRestrictionHeaders
IpAddress string: The IP Address used for this IP Restriction in CIDR notation.
Name string: The name of the Function App resource.
Priority int: The priority for this IP Restriction.
ServiceTag string: The Service Tag used for this IP Restriction.
VirtualNetworkSubnetId string: The Virtual Network Subnet ID used for this IP Restriction.

Action string: Allow or Deny access for this IP range. Defaults to Allow.
Headers GetFunctionAppSiteConfigIpRestrictionHeaders
IpAddress string: The IP Address used for this IP Restriction in CIDR notation.
Name string: The name of the Function App resource.
Priority int: The priority for this IP Restriction.
ServiceTag string: The Service Tag used for this IP Restriction.
VirtualNetworkSubnetId string: The Virtual Network Subnet ID used for this IP Restriction.

action String: Allow or Deny access for this IP range. Defaults to Allow.
headers GetFunctionAppSiteConfigIpRestrictionHeaders
ipAddress String: The IP Address used for this IP Restriction in CIDR notation.
name String: The name of the Function App resource.
priority Integer: The priority for this IP Restriction.
serviceTag String: The Service Tag used for this IP Restriction.
virtualNetworkSubnetId String: The Virtual Network Subnet ID used for this IP Restriction.

action string: Allow or Deny access for this IP range. Defaults to Allow.
headers GetFunctionAppSiteConfigIpRestrictionHeaders
ipAddress string: The IP Address used for this IP Restriction in CIDR notation.
name string: The name of the Function App resource.
priority number: The priority for this IP Restriction.
serviceTag string: The Service Tag used for this IP Restriction.
virtualNetworkSubnetId string: The Virtual Network Subnet ID used for this IP Restriction.

action str: Allow or Deny access for this IP range. Defaults to Allow.
headers GetFunctionAppSiteConfigIpRestrictionHeaders
ip_address str: The IP Address used for this IP Restriction in CIDR notation.
name str: The name of the Function App resource.
priority int: The priority for this IP Restriction.
service_tag str: The Service Tag used for this IP Restriction.
virtual_network_subnet_id str: The Virtual Network Subnet ID used for this IP Restriction.

action String: Allow or Deny access for this IP range. Defaults to Allow.
headers Property Map
ipAddress String: The IP Address used for this IP Restriction in CIDR notation.
name String: The name of the Function App resource.
priority Number: The priority for this IP Restriction.
serviceTag String: The Service Tag used for this IP Restriction.
virtualNetworkSubnetId String: The Virtual Network Subnet ID used for this IP Restriction.

GetFunctionAppSiteConfigIpRestrictionHeaders

XAzureFdids List<string>
XFdHealthProbes List<string>
XForwardedFors List<string>
XForwardedHosts List<string>

XAzureFdids []string
XFdHealthProbes []string
XForwardedFors []string
XForwardedHosts []string

xAzureFdids List<String>
xFdHealthProbes List<String>
xForwardedFors List<String>
xForwardedHosts List<String>

xAzureFdids string[]
xFdHealthProbes string[]
xForwardedFors string[]
xForwardedHosts string[]

x_azure_fdids Sequence[str]
x_fd_health_probes Sequence[str]
x_forwarded_fors Sequence[str]
x_forwarded_hosts Sequence[str]

xAzureFdids List<String>
xFdHealthProbes List<String>
xForwardedFors List<String>
xForwardedHosts List<String>

GetFunctionAppSiteConfigScmIpRestriction

Action string: Allow or Deny access for this IP range. Defaults to Allow.
Headers GetFunctionAppSiteConfigScmIpRestrictionHeaders
IpAddress string: The IP Address used for this IP Restriction in CIDR notation.
Name string: The name of the Function App resource.
Priority int: The priority for this IP Restriction.
ServiceTag string: The Service Tag used for this IP Restriction.
VirtualNetworkSubnetId string: The Virtual Network Subnet ID used for this IP Restriction.

Action string: Allow or Deny access for this IP range. Defaults to Allow.
Headers GetFunctionAppSiteConfigScmIpRestrictionHeaders
IpAddress string: The IP Address used for this IP Restriction in CIDR notation.
Name string: The name of the Function App resource.
Priority int: The priority for this IP Restriction.
ServiceTag string: The Service Tag used for this IP Restriction.
VirtualNetworkSubnetId string: The Virtual Network Subnet ID used for this IP Restriction.

action String: Allow or Deny access for this IP range. Defaults to Allow.
headers GetFunctionAppSiteConfigScmIpRestrictionHeaders
ipAddress String: The IP Address used for this IP Restriction in CIDR notation.
name String: The name of the Function App resource.
priority Integer: The priority for this IP Restriction.
serviceTag String: The Service Tag used for this IP Restriction.
virtualNetworkSubnetId String: The Virtual Network Subnet ID used for this IP Restriction.

action string: Allow or Deny access for this IP range. Defaults to Allow.
headers GetFunctionAppSiteConfigScmIpRestrictionHeaders
ipAddress string: The IP Address used for this IP Restriction in CIDR notation.
name string: The name of the Function App resource.
priority number: The priority for this IP Restriction.
serviceTag string: The Service Tag used for this IP Restriction.
virtualNetworkSubnetId string: The Virtual Network Subnet ID used for this IP Restriction.

action str: Allow or Deny access for this IP range. Defaults to Allow.
headers GetFunctionAppSiteConfigScmIpRestrictionHeaders
ip_address str: The IP Address used for this IP Restriction in CIDR notation.
name str: The name of the Function App resource.
priority int: The priority for this IP Restriction.
service_tag str: The Service Tag used for this IP Restriction.
virtual_network_subnet_id str: The Virtual Network Subnet ID used for this IP Restriction.

action String: Allow or Deny access for this IP range. Defaults to Allow.
headers Property Map
ipAddress String: The IP Address used for this IP Restriction in CIDR notation.
name String: The name of the Function App resource.
priority Number: The priority for this IP Restriction.
serviceTag String: The Service Tag used for this IP Restriction.
virtualNetworkSubnetId String: The Virtual Network Subnet ID used for this IP Restriction.

GetFunctionAppSiteConfigScmIpRestrictionHeaders

XAzureFdids List<string>
XFdHealthProbes List<string>
XForwardedFors List<string>
XForwardedHosts List<string>

XAzureFdids []string
XFdHealthProbes []string
XForwardedFors []string
XForwardedHosts []string

xAzureFdids List<String>
xFdHealthProbes List<String>
xForwardedFors List<String>
xForwardedHosts List<String>

xAzureFdids string[]
xFdHealthProbes string[]
xForwardedFors string[]
xForwardedHosts string[]

x_azure_fdids Sequence[str]
x_fd_health_probes Sequence[str]
x_forwarded_fors Sequence[str]
x_forwarded_hosts Sequence[str]

xAzureFdids List<String>
xFdHealthProbes List<String>
xForwardedFors List<String>
xForwardedHosts List<String>

GetFunctionAppSiteCredential

Password string: The password associated with the username, which can be used to publish to this App Service.
Username string: The username which can be used to publish to this App Service

Password string: The password associated with the username, which can be used to publish to this App Service.
Username string: The username which can be used to publish to this App Service

password String: The password associated with the username, which can be used to publish to this App Service.
username String: The username which can be used to publish to this App Service

password string: The password associated with the username, which can be used to publish to this App Service.
username string: The username which can be used to publish to this App Service

password str: The password associated with the username, which can be used to publish to this App Service.
username str: The username which can be used to publish to this App Service

password String: The password associated with the username, which can be used to publish to this App Service.
username String: The username which can be used to publish to this App Service

GetFunctionAppSourceControl

Branch string: The branch of the remote repository in use.
ManualIntegration bool: Limits to manual integration.
RepoUrl string: The URL of the source code repository.
RollbackEnabled bool: Is roll-back enabled for the repository.
UseMercurial bool: Uses Mercurial if true, otherwise uses Git.

Branch string: The branch of the remote repository in use.
ManualIntegration bool: Limits to manual integration.
RepoUrl string: The URL of the source code repository.
RollbackEnabled bool: Is roll-back enabled for the repository.
UseMercurial bool: Uses Mercurial if true, otherwise uses Git.

branch String: The branch of the remote repository in use.
manualIntegration Boolean: Limits to manual integration.
repoUrl String: The URL of the source code repository.
rollbackEnabled Boolean: Is roll-back enabled for the repository.
useMercurial Boolean: Uses Mercurial if true, otherwise uses Git.

branch string: The branch of the remote repository in use.
manualIntegration boolean: Limits to manual integration.
repoUrl string: The URL of the source code repository.
rollbackEnabled boolean: Is roll-back enabled for the repository.
useMercurial boolean: Uses Mercurial if true, otherwise uses Git.

branch str: The branch of the remote repository in use.
manual_integration bool: Limits to manual integration.
repo_url str: The URL of the source code repository.
rollback_enabled bool: Is roll-back enabled for the repository.
use_mercurial bool: Uses Mercurial if true, otherwise uses Git.

branch String: The branch of the remote repository in use.
manualIntegration Boolean: Limits to manual integration.
repoUrl String: The URL of the source code repository.
rollbackEnabled Boolean: Is roll-back enabled for the repository.
useMercurial Boolean: Uses Mercurial if true, otherwise uses Git.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

pulumi/pulumi-azure

azure.appservice.getFunctionApp

On this page

On this page

Example Usage

Using getFunctionApp

getFunctionApp Result

Supporting Types

GetFunctionAppConnectionString

GetFunctionAppIdentity

GetFunctionAppSiteConfig

GetFunctionAppSiteConfigCors

GetFunctionAppSiteConfigIpRestriction

GetFunctionAppSiteConfigIpRestrictionHeaders

GetFunctionAppSiteConfigScmIpRestriction

GetFunctionAppSiteConfigScmIpRestrictionHeaders

GetFunctionAppSiteCredential

GetFunctionAppSourceControl

Package Details

On this page

On this page