1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. WebAppFunction
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

azure-native.web.WebAppFunction

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

    Function information. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2020-12-01.

    Other available API versions: 2016-08-01, 2020-10-01, 2023-01-01, 2023-12-01.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:web:WebAppFunction myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName} 
    

    Create WebAppFunction Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WebAppFunction(name: string, args: WebAppFunctionArgs, opts?: CustomResourceOptions);
    @overload
    def WebAppFunction(resource_name: str,
                       args: WebAppFunctionArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def WebAppFunction(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       kind: Optional[str] = None,
                       language: Optional[str] = None,
                       function_name: Optional[str] = None,
                       href: Optional[str] = None,
                       invoke_url_template: Optional[str] = None,
                       is_disabled: Optional[bool] = None,
                       config: Optional[Any] = None,
                       function_app_id: Optional[str] = None,
                       files: Optional[Mapping[str, str]] = None,
                       config_href: Optional[str] = None,
                       script_href: Optional[str] = None,
                       script_root_path_href: Optional[str] = None,
                       secrets_file_href: Optional[str] = None,
                       test_data: Optional[str] = None,
                       test_data_href: Optional[str] = None)
    func NewWebAppFunction(ctx *Context, name string, args WebAppFunctionArgs, opts ...ResourceOption) (*WebAppFunction, error)
    public WebAppFunction(string name, WebAppFunctionArgs args, CustomResourceOptions? opts = null)
    public WebAppFunction(String name, WebAppFunctionArgs args)
    public WebAppFunction(String name, WebAppFunctionArgs args, CustomResourceOptions options)
    
    type: azure-native:web:WebAppFunction
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args WebAppFunctionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WebAppFunctionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WebAppFunctionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebAppFunctionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebAppFunctionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var webAppFunctionResource = new AzureNative.Web.WebAppFunction("webAppFunctionResource", new()
    {
        Name = "string",
        ResourceGroupName = "string",
        Kind = "string",
        Language = "string",
        FunctionName = "string",
        Href = "string",
        InvokeUrlTemplate = "string",
        IsDisabled = false,
        Config = "any",
        FunctionAppId = "string",
        Files = 
        {
            { "string", "string" },
        },
        ConfigHref = "string",
        ScriptHref = "string",
        ScriptRootPathHref = "string",
        SecretsFileHref = "string",
        TestData = "string",
        TestDataHref = "string",
    });
    
    example, err := web.NewWebAppFunction(ctx, "webAppFunctionResource", &web.WebAppFunctionArgs{
    	Name:              pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	Kind:              pulumi.String("string"),
    	Language:          pulumi.String("string"),
    	FunctionName:      pulumi.String("string"),
    	Href:              pulumi.String("string"),
    	InvokeUrlTemplate: pulumi.String("string"),
    	IsDisabled:        pulumi.Bool(false),
    	Config:            pulumi.Any("any"),
    	FunctionAppId:     pulumi.String("string"),
    	Files: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	ConfigHref:         pulumi.String("string"),
    	ScriptHref:         pulumi.String("string"),
    	ScriptRootPathHref: pulumi.String("string"),
    	SecretsFileHref:    pulumi.String("string"),
    	TestData:           pulumi.String("string"),
    	TestDataHref:       pulumi.String("string"),
    })
    
    var webAppFunctionResource = new WebAppFunction("webAppFunctionResource", WebAppFunctionArgs.builder()
        .name("string")
        .resourceGroupName("string")
        .kind("string")
        .language("string")
        .functionName("string")
        .href("string")
        .invokeUrlTemplate("string")
        .isDisabled(false)
        .config("any")
        .functionAppId("string")
        .files(Map.of("string", "string"))
        .configHref("string")
        .scriptHref("string")
        .scriptRootPathHref("string")
        .secretsFileHref("string")
        .testData("string")
        .testDataHref("string")
        .build());
    
    web_app_function_resource = azure_native.web.WebAppFunction("webAppFunctionResource",
        name="string",
        resource_group_name="string",
        kind="string",
        language="string",
        function_name="string",
        href="string",
        invoke_url_template="string",
        is_disabled=False,
        config="any",
        function_app_id="string",
        files={
            "string": "string",
        },
        config_href="string",
        script_href="string",
        script_root_path_href="string",
        secrets_file_href="string",
        test_data="string",
        test_data_href="string")
    
    const webAppFunctionResource = new azure_native.web.WebAppFunction("webAppFunctionResource", {
        name: "string",
        resourceGroupName: "string",
        kind: "string",
        language: "string",
        functionName: "string",
        href: "string",
        invokeUrlTemplate: "string",
        isDisabled: false,
        config: "any",
        functionAppId: "string",
        files: {
            string: "string",
        },
        configHref: "string",
        scriptHref: "string",
        scriptRootPathHref: "string",
        secretsFileHref: "string",
        testData: "string",
        testDataHref: "string",
    });
    
    type: azure-native:web:WebAppFunction
    properties:
        config: any
        configHref: string
        files:
            string: string
        functionAppId: string
        functionName: string
        href: string
        invokeUrlTemplate: string
        isDisabled: false
        kind: string
        language: string
        name: string
        resourceGroupName: string
        scriptHref: string
        scriptRootPathHref: string
        secretsFileHref: string
        testData: string
        testDataHref: string
    

    WebAppFunction Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The WebAppFunction resource accepts the following input properties:

    Name string
    Site name.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    Config object
    Config information.
    ConfigHref string
    Config URI.
    Files Dictionary<string, string>
    File list.
    FunctionAppId string
    Function App ID.
    FunctionName string
    Function name.
    Href string
    Function URI.
    InvokeUrlTemplate string
    The invocation URL
    IsDisabled bool
    Gets or sets a value indicating whether the function is disabled
    Kind string
    Kind of resource.
    Language string
    The function language
    ScriptHref string
    Script URI.
    ScriptRootPathHref string
    Script root path URI.
    SecretsFileHref string
    Secrets file URI.
    TestData string
    Test data used when testing via the Azure Portal.
    TestDataHref string
    Test data URI.
    Name string
    Site name.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    Config interface{}
    Config information.
    ConfigHref string
    Config URI.
    Files map[string]string
    File list.
    FunctionAppId string
    Function App ID.
    FunctionName string
    Function name.
    Href string
    Function URI.
    InvokeUrlTemplate string
    The invocation URL
    IsDisabled bool
    Gets or sets a value indicating whether the function is disabled
    Kind string
    Kind of resource.
    Language string
    The function language
    ScriptHref string
    Script URI.
    ScriptRootPathHref string
    Script root path URI.
    SecretsFileHref string
    Secrets file URI.
    TestData string
    Test data used when testing via the Azure Portal.
    TestDataHref string
    Test data URI.
    name String
    Site name.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    config Object
    Config information.
    configHref String
    Config URI.
    files Map<String,String>
    File list.
    functionAppId String
    Function App ID.
    functionName String
    Function name.
    href String
    Function URI.
    invokeUrlTemplate String
    The invocation URL
    isDisabled Boolean
    Gets or sets a value indicating whether the function is disabled
    kind String
    Kind of resource.
    language String
    The function language
    scriptHref String
    Script URI.
    scriptRootPathHref String
    Script root path URI.
    secretsFileHref String
    Secrets file URI.
    testData String
    Test data used when testing via the Azure Portal.
    testDataHref String
    Test data URI.
    name string
    Site name.
    resourceGroupName string
    Name of the resource group to which the resource belongs.
    config any
    Config information.
    configHref string
    Config URI.
    files {[key: string]: string}
    File list.
    functionAppId string
    Function App ID.
    functionName string
    Function name.
    href string
    Function URI.
    invokeUrlTemplate string
    The invocation URL
    isDisabled boolean
    Gets or sets a value indicating whether the function is disabled
    kind string
    Kind of resource.
    language string
    The function language
    scriptHref string
    Script URI.
    scriptRootPathHref string
    Script root path URI.
    secretsFileHref string
    Secrets file URI.
    testData string
    Test data used when testing via the Azure Portal.
    testDataHref string
    Test data URI.
    name str
    Site name.
    resource_group_name str
    Name of the resource group to which the resource belongs.
    config Any
    Config information.
    config_href str
    Config URI.
    files Mapping[str, str]
    File list.
    function_app_id str
    Function App ID.
    function_name str
    Function name.
    href str
    Function URI.
    invoke_url_template str
    The invocation URL
    is_disabled bool
    Gets or sets a value indicating whether the function is disabled
    kind str
    Kind of resource.
    language str
    The function language
    script_href str
    Script URI.
    script_root_path_href str
    Script root path URI.
    secrets_file_href str
    Secrets file URI.
    test_data str
    Test data used when testing via the Azure Portal.
    test_data_href str
    Test data URI.
    name String
    Site name.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    config Any
    Config information.
    configHref String
    Config URI.
    files Map<String>
    File list.
    functionAppId String
    Function App ID.
    functionName String
    Function name.
    href String
    Function URI.
    invokeUrlTemplate String
    The invocation URL
    isDisabled Boolean
    Gets or sets a value indicating whether the function is disabled
    kind String
    Kind of resource.
    language String
    The function language
    scriptHref String
    Script URI.
    scriptRootPathHref String
    Script root path URI.
    secretsFileHref String
    Secrets file URI.
    testData String
    Test data used when testing via the Azure Portal.
    testDataHref String
    Test data URI.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WebAppFunction resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Resource type.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Resource type.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Resource type.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Resource type.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi