Cloud.Service.Azure.Function.App

JSON Example

{
    "app_service_plan_id": "string",
    "client_affinity_enabled": false,
    "connection_string": [
        {
            "name": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "default_hostname": "string",
    "enabled": false,
    "https_only": false,
    "identity": [
        {
            "principal_id": "string",
            "tenant_id": "string",
            "type": "string"
        }
    ],
    "name": "string",
    "outbound_ip_addresses": "string",
    "provider": "string",
    "region": "string",
    "resource_group_name": "string",
    "site_config": [
        {
            "always_on": false,
            "use_32_bit_worker_process": false,
            "websockets_enabled": false
        }
    ],
    "site_credential": [
        {
            "password": "string",
            "username": "string"
        }
    ],
    "storage_connection_string": "string",
    "version": "string"
}

string

app_service_plan_id

Required

(Required) App Service Plan within which to create the Function App. Changing the App Service Plan deletes the existing resource and creates a new one.

object

app_settings

Optional

Key-value pairs of settings for the web app.

boolean

client_affinity_enabled

Optional

Whether the Function App sends session affinity cookies so that client requests in the same session are routed to the same instance.

array of object

connection_string

Optional

Connection string settings.

string

default_hostname

Optional

Hostname associated with the Function App. For example: mysite.azurewebsites.net

boolean

enabled

Optional

Whether the Function App is enabled or disabled.

boolean

https_only

Optional

Whether the Function App can only be accessed via HTTPS. Default is false.

array of object

identity

Optional

Function App managed service identity settings.

string

name

Required

(Required) Function App name. Changing the Function App name deletes the existing resource and creates a new one.

string

outbound_ip_addresses

Optional

Comma separated list of outbound IP addresses. For example: 52.23.25.3,52.143.43.12

string

provider

Required

(Required) The name of the Microsoft Azure cloud account to use for this resource

string

region

Required

(Required) The Location property for this resource

string

resource_group_name

Required

(Required) Azure resource group in which to create the Function App.

array of object

site_config

Optional

Web app configuration settings.

array of object

site_credential

Optional

Site credential settings used to publish to the Function App.

string

storage_connection_string

Required

(Required) Connection string of the back-end storage account used by the Function App for content such as a dashboard or logs.

object