API Connection

Overview

This example defines an API Connection.

{
	"app_service_plan": {
		"name": "apic-example-{env}",
		"display_name": "My Display Name",
		"details": {
			"type": "ApplicationInsights",
			"@application_insights_name": "appi-my-insights-name-{env}",
			"@key_vault_name": "kv-example-{env}",
			"secret_name": "TheNameOfTheSecretContainingApiKey",
		},
		"location": "northeurope",
		"external": false,
		"resource_group_name": "my-rg-name",
		"tags": { "example": "S0" }
	}
}

---

API Connection Reference

Key	Value	Description
name (required)	string	The name of the plan (see how to name)
display_name (required)	string	The name of the plan (see how to name)
details (required)	One of DetailsType	Kind of the App Service Plan
location	string	Resource Location (defaults to the resource group location)
external	bool	A reference to an existing App Service Plan (defaults to false)
resource_group_name	string	The name of the resource group where the resource is located, only with external resources (defaults to the resource group of the deployment)
tags	object	Additional tags for the resource (defaults to no additional tags)

---

Details Type

Value	Type
ApplicationInsights	ApplicationInsightsType
AzureLogAnalytics	AzureLogAnalyticsType
AzureLogAnalyticsDataCollector	AzureLogAnalyticsDataCollector
AzureBlob	AzureBlobType
Dynamic	DynamicType
Sendgrid	SendgridType

Application Insights Type

Key	Type	Description
@application_insights_name (required)	string	A reference to an application insights resource
@key_vault_name (required)	string	A reference to a key vault resource
secret_name (required)	string	The name of the secret inside of the vault

Azure Log Analytics Type

Key	Type	Description
@log_analytics_name (required)	string	A reference to log analytics resource
@key_vault_name (required)	string	A reference to a key vault resource
service_principal_id (required)	string	the id of the service principal to use

Azure Log Analytics Data Collector Type

Key	Type	Description
@log_analytics_name (required)	string	A reference to log analytics resource

Azure Blob Type

Key	Type	Description
@storage_account_name (required)	string	A reference to a storage account resource

Dynamic Type

Key	Type	Description
type (required)	string	The type of the API Connection
parameter_values (required)	array of ApiConnectionParam	The type of the API Connection

Api Connection Param

Key	Type	Description
name (required)	string	The name of the parameter
value (required)	string	Value of the parameter

Sendgrid Type

Key	Type	Description
@key_vault_name (required)	string	A reference to a key vault resource
secret_name (required)	string	The name of the secret inside of the vault