如何通过Terraform部署状态为Connected的Azure API Connection

你手动在statuses里设置"status": "Connected"不会生效，因为这个字段只是显示用的状态标识，实际连接状态由Azure后端根据授权参数的有效性决定。要让部署后的连接器直接处于Connected状态，必须在代码中提供完成身份验证所需的参数，具体步骤如下：

1. 确定目标Managed API所需的授权参数 #

不同的Managed API（比如Office 365 Outlook、SendGrid、SQL等）需要的授权参数不同，你可以通过以下方式确认：

• 在Azure门户中手动创建该API连接，记录配置时需要填写的参数（比如API Key、Client ID、Client Secret、Tenant ID等）
• 调用Azure REST API GET /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/managedApis/{apiName}，查看properties.connectionParameters字段，了解必填参数

2. 在Terraform代码中填充parameterValues #

将获取到的授权参数填入parameterValues对象中，以下是两个常见场景的示例：

示例1：API Key类型的连接器（比如SendGrid） #

resource "azapi_resource" "createApiConnectionABC" {
  type      = "Microsoft.Web/connections@2016-06-01"
  name      = var.connection_name
  parent_id = var.resource_group.id
  location  = var.resource_group.location
  tags      = var.resource_tags

  body = jsonencode({
    properties = {
      displayName = var.connection_name
      statuses = [
        {
          "status" : "Connected"
        }
      ]
      parameterValues = {
        "apiKey" = var.sendgrid_api_key # 替换为实际的API Key变量
      }
      customParameterValues = {}

      api = {
        name        = var.connection_name
        displayName = "Sample Name"
        description = "Sample Description"
        iconUri     = "sample-uri"
        brandColor  = "#0072C6"
        id          = "/subscriptions/${var.subscription_id}/providers/Microsoft.Web/locations/${var.resource_group.location}/managedApis/${var.connection_name}"
        type        = "Microsoft.Web/locations/managedApis"
      }
    }
  })
}

示例2：OAuth 2.0类型的连接器（比如Office 365 Outlook） #

对于OAuth类型，除了基本参数，可能需要通过azapi_resource_action触发授权流程（部分场景需要），示例代码如下：

resource "azapi_resource" "createApiConnectionABC" {
  type      = "Microsoft.Web/connections@2016-06-01"
  name      = var.connection_name
  parent_id = var.resource_group.id
  location  = var.resource_group.location
  tags      = var.resource_tags

  body = jsonencode({
    properties = {
      displayName = var.connection_name
      statuses = [
        {
          "status" : "Connected"
        }
      ]
      parameterValues = {
        "token:clientId" = var.oauth_client_id
        "token:clientSecret" = var.oauth_client_secret
        "token:tenantId" = var.tenant_id
        "token:grantType" = "client_credentials"
      }
      customParameterValues = {}

      api = {
        name        = var.connection_name
        displayName = "Sample Name"
        description = "Sample Description"
        iconUri     = "sample-uri"
        brandColor  = "#0072C6"
        id          = "/subscriptions/${var.subscription_id}/providers/Microsoft.Web/locations/${var.resource_group.location}/managedApis/${var.connection_name}"
        type        = "Microsoft.Web/locations/managedApis"
      }
    }
  })
}

# 部分OAuth连接器需要调用listSecrets来激活连接
resource "azapi_resource_action" "activate_connection" {
  resource_id = azapi_resource.createApiConnectionABC.id
  action      = "listSecrets"
  method      = "POST"
}

3. 注意事项 #

• 敏感参数（比如API Key、Client Secret）不要硬编码，使用Terraform变量或Azure Key Vault引用
• 部分连接器可能需要特定的权限（比如Azure AD应用权限），确保提前配置好
• 如果仍无法生效，检查Azure门户中连接器的错误详情，根据提示补充缺失的参数或配置

内容的提问来源于stack exchange，提问作者Akila Induranga