Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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@2016-08-01' = {
parent: resourceSymbolicName
kind: 'string'
name: 'string'
properties: {
config: any(...)
configHref: 'string'
files: {
{customized property}: 'string'
}
href: 'string'
scriptHref: 'string'
scriptRootPathHref: 'string'
secretsFileHref: 'string'
testData: 'string'
}
}
Property Values
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 |
FunctionEnvelopeProperties
Name | Description | Value |
---|---|---|
config | Config information. | any |
configHref | Config URI. | string |
files | File list. | FunctionEnvelopePropertiesFiles |
href | Function URI. | string |
scriptHref | Script URI. | string |
scriptRootPathHref | Script root path URI. | string |
secretsFileHref | Secrets file URI. | string |
testData | Test data used when testing via the Azure Portal. | string |
FunctionEnvelopePropertiesFiles
Name | Description | Value |
---|
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying 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": "2016-08-01",
"name": "string",
"kind": "string",
"properties": {
"config": {},
"configHref": "string",
"files": {
"{customized property}": "string"
},
"href": "string",
"scriptHref": "string",
"scriptRootPathHref": "string",
"secretsFileHref": "string",
"testData": "string"
}
}
Property Values
Microsoft.Web/sites/functions
Name | Description | Value |
---|---|---|
apiVersion | The api version | '2016-08-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' |
FunctionEnvelopeProperties
Name | Description | Value |
---|---|---|
config | Config information. | any |
configHref | Config URI. | string |
files | File list. | FunctionEnvelopePropertiesFiles |
href | Function URI. | string |
scriptHref | Script URI. | string |
scriptRootPathHref | Script root path URI. | string |
secretsFileHref | Secrets file URI. | string |
testData | Test data used when testing via the Azure Portal. | string |
FunctionEnvelopePropertiesFiles
Name | Description | Value |
---|
Usage Examples
Azure Quickstart Templates
The following Azure 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@2016-08-01"
name = "string"
parent_id = "string"
body = {
kind = "string"
properties = {
config = ?
configHref = "string"
files = {
{customized property} = "string"
}
href = "string"
scriptHref = "string"
scriptRootPathHref = "string"
secretsFileHref = "string"
testData = "string"
}
}
}
Property Values
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@2016-08-01" |
FunctionEnvelopeProperties
Name | Description | Value |
---|---|---|
config | Config information. | any |
configHref | Config URI. | string |
files | File list. | FunctionEnvelopePropertiesFiles |
href | Function URI. | string |
scriptHref | Script URI. | string |
scriptRootPathHref | Script root path URI. | string |
secretsFileHref | Secrets file URI. | string |
testData | Test data used when testing via the Azure Portal. | string |
FunctionEnvelopePropertiesFiles
Name | Description | Value |
---|