Microsoft.Web sites/functions 2021-01-01

• Latest
• 2024-04-01
• 2023-12-01
• 2023-01-01
• 2022-09-01
• 2022-03-01
• 2021-03-01
• 2021-02-01
• 2021-01-15
• 2021-01-01
• 2020-12-01
• 2020-10-01
• 2020-09-01
• 2020-06-01
• 2019-08-01
• 2018-11-01
• 2018-02-01
• 2016-08-01

Bicep resource definition

The sites/functions resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/sites/functions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/sites/functions@2021-01-01' = {
  kind: 'string'
  name: 'string'
  properties: {
    config: any(Azure.Bicep.Types.Concrete.AnyType)
    config_href: 'string'
    files: {
      {customized property}: 'string'
    }
    function_app_id: 'string'
    href: 'string'
    invoke_url_template: 'string'
    isDisabled: bool
    language: 'string'
    script_href: 'string'
    script_root_path_href: 'string'
    secrets_file_href: 'string'
    test_data: 'string'
    test_data_href: 'string'
  }
}

Property values

FunctionEnvelopeProperties

Name	Description	Value
config	Config information.	any
config_href	Config URI.	string
files	File list.	FunctionEnvelopePropertiesFiles
function_app_id	Function App ID.	string
href	Function URI.	string
invoke_url_template	The invocation URL	string
isDisabled	Gets or sets a value indicating whether the function is disabled	bool
language	The function language	string
script_href	Script URI.	string
script_root_path_href	Script root path URI.	string
secrets_file_href	Secrets file URI.	string
test_data	Test data used when testing via the Azure Portal.	string
test_data_href	Test data URI.	string

FunctionEnvelopePropertiesFiles

Name	Description	Value

Microsoft.Web/sites/functions

Name	Description	Value
kind	Kind of resource.	string
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: sites
properties	FunctionEnvelope resource specific properties	FunctionEnvelopeProperties

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Azure Function app and an HTTP-triggered function	This example deploys an Azure Function app and an HTTP-triggered function inline in the template. It also deploys a Key Vault and populates a secret with the function app's host key.
Front Door Standard/Premium with Azure Functions origin	This template creates a Front Door Standard/Premium, an Azure Functions app, and configures the function app to validate that traffic has come through the Front Door origin.

ARM template resource definition

The sites/functions resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/sites/functions resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/sites/functions",
  "apiVersion": "2021-01-01",
  "name": "string",
  "kind": "string",
  "properties": {
    "config": {},
    "config_href": "string",
    "files": {
      "{customized property}": "string"
    },
    "function_app_id": "string",
    "href": "string",
    "invoke_url_template": "string",
    "isDisabled": "bool",
    "language": "string",
    "script_href": "string",
    "script_root_path_href": "string",
    "secrets_file_href": "string",
    "test_data": "string",
    "test_data_href": "string"
  }
}

Property values

FunctionEnvelopeProperties

Name	Description	Value
config	Config information.	any
config_href	Config URI.	string
files	File list.	FunctionEnvelopePropertiesFiles
function_app_id	Function App ID.	string
href	Function URI.	string
invoke_url_template	The invocation URL	string
isDisabled	Gets or sets a value indicating whether the function is disabled	bool
language	The function language	string
script_href	Script URI.	string
script_root_path_href	Script root path URI.	string
secrets_file_href	Secrets file URI.	string
test_data	Test data used when testing via the Azure Portal.	string
test_data_href	Test data URI.	string

FunctionEnvelopePropertiesFiles

Name	Description	Value

Microsoft.Web/sites/functions

Name	Description	Value
apiVersion	The api version	'2021-01-01'
kind	Kind of resource.	string
name	The resource name	string (required)
properties	FunctionEnvelope resource specific properties	FunctionEnvelopeProperties
type	The resource type	'Microsoft.Web/sites/functions'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Azure Function app and an HTTP-triggered function	This example deploys an Azure Function app and an HTTP-triggered function inline in the template. It also deploys a Key Vault and populates a secret with the function app's host key.
Azure function with transform capabilites	Creates a webhook based C# azure function with transform capabilites to use in logic apps integration scenarios
Front Door Standard/Premium with Azure Functions origin	This template creates a Front Door Standard/Premium, an Azure Functions app, and configures the function app to validate that traffic has come through the Front Door origin.

Terraform (AzAPI provider) resource definition

The sites/functions resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/sites/functions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/functions@2021-01-01"
  name = "string"
  kind = "string"
  body = jsonencode({
    properties = {
      config = ?
      config_href = "string"
      files = {
        {customized property} = "string"
      }
      function_app_id = "string"
      href = "string"
      invoke_url_template = "string"
      isDisabled = bool
      language = "string"
      script_href = "string"
      script_root_path_href = "string"
      secrets_file_href = "string"
      test_data = "string"
      test_data_href = "string"
    }
  })
}

Property values

FunctionEnvelopeProperties

Name	Description	Value
config	Config information.	any
config_href	Config URI.	string
files	File list.	FunctionEnvelopePropertiesFiles
function_app_id	Function App ID.	string
href	Function URI.	string
invoke_url_template	The invocation URL	string
isDisabled	Gets or sets a value indicating whether the function is disabled	bool
language	The function language	string
script_href	Script URI.	string
script_root_path_href	Script root path URI.	string
secrets_file_href	Secrets file URI.	string
test_data	Test data used when testing via the Azure Portal.	string
test_data_href	Test data URI.	string

FunctionEnvelopePropertiesFiles

Name	Description	Value

Microsoft.Web/sites/functions

Name	Description	Value
kind	Kind of resource.	string
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: sites
properties	FunctionEnvelope resource specific properties	FunctionEnvelopeProperties
type	The resource type	"Microsoft.Web/sites/functions@2021-01-01"