AzureAzure Logic Apps / Connectorsazurerm_api_connectionPro

How to Import an Azure API Connection into Terraform

To import an existing Azure API Connection into Terraform, scan it with Terraback and run terraback azure import --method bulk. Terraback writes the matching azurerm_api_connection resource block and the Terraform 1.5+ import block for you, so you do not have to run terraform import by hand. The import ID is the full resource ID (.../providers/Microsoft.Web/connections/<name>).

Import Azure API Connection with Terraback (recommended)

Terraback reverse-engineers your live infrastructure: it reads the Azure Logic Apps / Connectors resource with read-only credentials, generates the HCL, and produces the exact import block. Two commands take you from a live Azure API Connection to managed Terraform.

1

Scan your Azure account

terraback scan all azure --subscription-id YOUR_ID
2

Generate import blocks and import into state

terraback azure import --method bulk

The Terraform import block

Terraback emits a Terraform 1.5+ import block like the one below. Because the block lives in your configuration, the import is reviewable in a pull request and repeatable across environments.

import {
  to = azurerm_api_connection.main
  id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/prod-rg/providers/Microsoft.Web/connections/prod-azureblob"
}

Example azurerm_api_connection configuration

Here is a realistic Azure API Connection block. Terraback generates a fuller version from your actual resource attributes; this is a minimal, valid starting point.

resource "azurerm_api_connection" "main" {
  name                = "prod-azureblob"
  resource_group_name = "prod-rg"
  managed_api_id      = "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Web/locations/eastus/managedApis/azureblob"
}

Gotchas when importing a Azure API Connection

  • The ARM type segment is Microsoft.Web/connections, even though the resource represents a managed-API connector used by Logic Apps.
  • managed_api_id points at a location-scoped managedApis entry (.../Microsoft.Web/locations/<region>/managedApis/<api>); the connector and the connection are in the same region.
  • parameter_values frequently holds credentials and is sensitive; after import, move secrets to variables rather than hardcoding them in the connection.
  • Connections are consumed by azurerm_logic_app_* resources via their connector references; importing the connection does not import the workflows that use it.

Doing it manually with terraform import

The native approach is to write the azurerm_api_connection block by hand, then run terraform import azurerm_api_connection.example <import-id> for every resource, one at a time. That works for a handful of resources, but it does not scale: you author all the HCL yourself and repeat the command for each item. Terraback generates the HCL and the import blocks for your whole account in one pass.

Import your whole Azure account in minutes

Terraback scans 80+ Azure resource types and emits clean Terraform plus import blocks, running locally with read-only credentials. $499 once, no SaaS.