Support for APIM Backend Headers Named Value

[Corendiel]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Some Backend configurations are not possible via Terraform. Currently, it only supports a string value and doesn't support the Named Value option. Storing backend credentials in terraform script is not ideal Named Value opens the path to the Key Vault option.

New or Affected Resource(s)

• azurerm_api_management_backend

Potential Terraform Configuration

resource "azurerm_api_management_backend" "example" {
  name                = "example-backend"
  resource_group_name = azurerm_resource_group.example.name
  api_management_name = azurerm_api_management.example.name
  protocol            = "http"
  url                 = "https://backend"
  credentials {
    header {
       name = Ocp-Apim-Subscription-Key
       named_value = azurerm_api_management_named_value.sub-key.name
    }
  }
}

References

https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/api_management_backend#header

• 0000

[mibo32]

@Corendiel Did you try this:

  credentials {
    header = {

      "x-functions-key" = "{{Named_value_name}}" 
    }
  }

It will automatically add it as a named value reference instead of a string value.

[emocibob]

  credentials {
    header = {

      "x-functions-key" = "{{Named_value_name}}" 
    }
  }

It will automatically add it as a named value reference instead of a string value.

In case someone stumbles on this issue, you can use string interpolation to reference an azurerm_api_management_named_value resource. Example:

  credentials {
    header = {
      "x-functions-key" = "{{${azurerm_api_management_named_value.example.name}}}"
    }
  }

[TanveerShell]

@emocibob If we use the below code in the backend credentials { header = { "x-functions-key" = "{{${azurerm_api_management_named_value.example.name}}}" } }

and refer the backend in the api operation , will the named-value secret get added in the function app host key as *"apim-" as this is auto populated when imported manually.