Microsoft.Web sites/functions
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@2022-09-01' = {
name: 'string'
kind: 'string'
parent: resourceSymbolicName
properties: {
config: any()
config_href: 'string'
files: {}
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
sites/functions
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| kind | Kind of resource. | string |
| 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 |
FunctionEnvelopeProperties
| Name | Description | Value |
|---|---|---|
| config | Config information. | For Bicep, you can use the any() function. |
| config_href | Config URI. | string |
| files | File list. | object |
| 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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
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. |
| 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 |
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": "2022-09-01",
"name": "string",
"kind": "string",
"properties": {
"config": {},
"config_href": "string",
"files": {},
"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
sites/functions
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Web/sites/functions' |
| apiVersion | The resource api version | '2022-09-01' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| kind | Kind of resource. | string |
| properties | FunctionEnvelope resource specific properties | FunctionEnvelopeProperties |
FunctionEnvelopeProperties
| Name | Description | Value |
|---|---|---|
| config | Config information. | |
| config_href | Config URI. | string |
| files | File list. | object |
| 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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| 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. |
| 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 |
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@2022-09-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
config_href = "string"
files = {}
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"
}
kind = "string"
})
}
Property values
sites/functions
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Web/sites/functions@2022-09-01" |
| 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 |
| kind | Kind of resource. | string |
| properties | FunctionEnvelope resource specific properties | FunctionEnvelopeProperties |
FunctionEnvelopeProperties
| Name | Description | Value |
|---|---|---|
| config | Config information. | |
| config_href | Config URI. | string |
| files | File list. | object |
| 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 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for