GetFunctionApp

Use this data source to access information about a Function App.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.AppService.GetFunctionApp.InvokeAsync(new Azure.AppService.GetFunctionAppArgs
        {
            Name = "test-azure-functions",
            ResourceGroupName = azurerm_resource_group.Example.Name,
        }));
    }

}

package main

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

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

import pulumi
import pulumi_azure as azure

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

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

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

Using GetFunctionApp

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

function  get_function_app(name=None, resource_group_name=None, tags=None, opts=None)

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

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

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

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 {[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 Dict[str, str]

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.
ConnectionStrings List<GetFunctionAppConnectionString>: An connection_string block as defined below.
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.
Location string
Name string: The name of the Connection String.
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
SiteCredentials List<GetFunctionAppSiteCredential>: A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.
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.
ConnectionStrings []GetFunctionAppConnectionString: An connection_string block as defined below.
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.
Location string
Name string: The name of the Connection String.
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
SiteCredentials []GetFunctionAppSiteCredential: A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.
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.
connectionStrings GetFunctionAppConnectionString[]: An connection_string block as defined below.
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.
location string
name string: The name of the Connection String.
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
siteCredentials GetFunctionAppSiteCredential[]: A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.
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 Dict[str, str]: A key-value pair of App Settings.
connection_strings List[GetFunctionAppConnectionString]: An connection_string block as defined below.
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.
location str
name str: The name of the Connection String.
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_credentials List[GetFunctionAppSiteCredential]: A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.
tags Dict[str, str]

Supporting Types

GetFunctionAppConnectionString

See the output API doc for this type.

Name string: The name of the Function App resource.
Type string: The type of the Connection String.
Value string: The value for the Connection String.

Name string: The name of the Function App resource.
Type string: The type of the Connection String.
Value string: The value for the Connection String.

name string: The name of the Function App resource.
type string: The type of the Connection String.
value string: The value for the Connection String.

name str: The name of the Function App resource.
type str: The type of the Connection String.
value str: The value for the Connection String.

GetFunctionAppSiteCredential

See the output API doc for this type.

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

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetFunctionApp

Example Usage

Using GetFunctionApp

GetFunctionApp Result

Supporting Types

GetFunctionAppConnectionString

GetFunctionAppSiteCredential

Package Details

On This Page