Azure Functions API Configuration

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "azure_function",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "config": {
    "function_app": "function_app_name",
    "custom_payloads": [
      {
        "value": "string",
        "key": "string"
      }
    ],
    "function_key": "function_key",
    "secrets_list": [
      {
        "value": "string",
        "key": "string"
      }
    ],
    "function_name": "function_name",
    "secrets": "{\"apiKey\" : \"yourApiKey\"}",
    "connection_method": "DIRECT | PRIVATE_LINK",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`function_app`	Function app name in Azure portal.
`custom_payloads`	The list of key-value pairs that can be used to specify custom information to the function at runtime.
`custom_payloads[0].value`	Payload Value
`custom_payloads[0].key`	Payload Key
`function_key`	Function key used for authorization.
`secrets_list`	The list of secrets that should be passed to the function at runtime.
`secrets_list[0].value`	Value
`secrets_list[0].key`	Key
`function_name`	Name of the function to be triggered.
`secrets`	The secrets that should be passed to the function at runtime.
`connection_method`	Connection Method. Possible values: `DIRECT`: Fivetran will connect directly to your function, `PRIVATE_LINK`: Fivetran will connect to your storage container using PrivateLink.
`schema`	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the function_app, function_name, function_key and secrets parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "azure_function",
  "group_id": "group_id",
  "config": {
    "function_app": "function_app_name",
    "function_name": "function_name",
    "function_key": "function_key",
    "secrets": "{\"apiKey\" : \"yourApiKey\"}"
  }
}

By using the Connect Card or the Fivetran dashboard.