Top / Microsoft Azure / Azure API Management / API Operation Policy

Azure API Management API Operation Policy

This page shows how to write Terraform and Azure Resource Manager for API Management API Operation Policy and write them securely.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

azurerm_api_management_api_operation_policy (Terraform)

The API Operation Policy in API Management can be configured in Terraform with the resource name azurerm_api_management_api_operation_policy. The following sections describe 10 examples of how to use the resource and its parameters.

Example Usage from GitHub

dadjokeAPI.tf#L40
resource "azurerm_api_management_api_operation_policy" "get-a-random-joke" {
  api_name            = azurerm_api_management_api.dadjoke.name
  resource_group_name = local.resource_group_name
  api_management_name = data.azurerm_api_management.apim.name
  operation_id = "get-a-random-joke"
operations.tf#L1
resource "azurerm_api_management_api_operation_policy" "get-users-userId" {
  count               = 1
  resource_group_name = local.shared-rg
  api_management_name = local.apim_name
  api_name            = azurerm_api_management_api.test-api.name
  operation_id        = "get-users-userId"
apim-api-fermium-v3-rev1.tf#L35
resource "azurerm_api_management_api_operation_policy" "fermium_v3_get-elements-by-atomic" {
  api_name            = azurerm_api_management_api.fermium_v3.name
  api_management_name = azurerm_api_management_api.fermium_v3.api_management_name
  resource_group_name = azurerm_api_management_api.fermium_v3.resource_group_name
  operation_id        = "get-elements-by-atomic"
  xml_link        = "https://raw.githubusercontent.com/krallice/fermium/master/api/fermium_v3_get-elements-by-atomic.xml"
26-api-management-api-operation-policy.tf#L1
resource "azurerm_api_management_api_operation_policy" "example" {
  api_name            = azurerm_api_management_api.hmi_apim_api.name
  api_management_name = azurerm_api_management.hmi_apim.name
  resource_group_name = azurerm_resource_group.hmi_apim_rg.name
  operation_id        = "request-hearing"
  xml_content = file("../template/api-request-hearings-policy.xml")
main.tf#L1
resource "azurerm_api_management_api_operation_policy" "oper_policy" {
  api_name            = var.name
  api_management_name = var.apim_name
  resource_group_name = var.rg_name
  operation_id        = var.operation_id
resource.tf#L1
resource "azurerm_api_management_api_operation_policy" "api_operation_policy" {
  count               = length(var.res_api_operation_policy)
  api_name            = var.res_api_name
  api_management_name = var.res_apim_name
  resource_group_name = var.res_rg_name
  operation_id        = var.res_api_operation_policy[count.index].operationid
main.tf#L20
resource "azurerm_api_management_api_operation_policy" "apim_api_operation_policy" {
  operation_id        = azurerm_api_management_api_operation.apim_api_operation.operation_id
  api_name            = azurerm_api_management_api_operation.apim_api_operation.api_name
  api_management_name = azurerm_api_management_api_operation.apim_api_operation.api_management_name
  resource_group_name = azurerm_api_management_api_operation.apim_api_operation.resource_group_name
  xml_content         = var.xml_content
main.tf#L1
resource "azurerm_api_management_api_operation_policy" "api_operation_policy" {
  count               = length(var.api_operation_policy)
  api_management_name = element(var.api_management_name, lookup(var.api_operation_policy[count.index], "api_management_id"))
  api_name            = element(var.api_name, lookup(var.api_operation_policy[count.index], "api_management_id"))
  operation_id        = element(var.operation_id, lookup(var.api_operation_policy[count.index], "operation_id"))
  resource_group_name = var.resource_group_name
api_operation_policy.tf#L1
resource "azurerm_api_management_api_operation_policy" "api_operation_policy" {
  api_name            = var.apima_name
  api_management_name = var.apim_name
  resource_group_name = var.resource_group_name
  operation_id        = var.operation_id
  xml_content         = var.xml_policy_file
policies.tf#L1
resource "azurerm_api_management_api_operation_policy" "geographicLocation-api" {
  api_name            = azurerm_api_management_api_operation.geographicLocationTest.api_name
  api_management_name = azurerm_api_management_api_operation.geographicLocationTest.api_management_name
  resource_group_name = azurerm_api_management_api_operation.geographicLocationTest.resource_group_name
  operation_id        = azurerm_api_management_api_operation.geographicLocationTest.operation_id

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

>> from Terraform Registry

Explanation in Terraform Registry

Manages an API Management API Operation Policy

>> from Terraform Registry

Microsoft.ApiManagement/service/apis/operations/policies (Azure Resource Manager)

The service/apis/operations/policies in Microsoft.ApiManagement can be configured in Azure Resource Manager with the resource name Microsoft.ApiManagement/service/apis/operations/policies. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

  • apiVersion required - string
  • name required - string

    The identifier of the Policy.

  • properties required
      • format optional - string

        Format of the policyContent.

      • value required - string

        Contents of the Policy as defined by the format.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure API Management Resources

Frequently asked questions

What is Azure API Management API Operation Policy?

Azure API Management API Operation Policy is a resource for API Management of Microsoft Azure. Settings can be wrote in Terraform.

Where can I find the example code for the Azure API Management API Operation Policy?

For Terraform, the fortunkam/apim-devops-demos, MohdmM01/terraform-azure-demo and krallice/fermium source code examples are useful. See the Terraform Example section for further details.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents