Top / Microsoft Azure / Azure API Management / Gateway

Azure API Management Gateway

This page shows how to write Terraform and Azure Resource Manager for API Management Gateway 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_gateway (Terraform)

The Gateway in API Management can be configured in Terraform with the resource name azurerm_api_management_gateway. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

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

The following arguments are supported:

  • name - (Required) The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.

  • api_management_name - (Required) The name of the API Management Service in which the gateway will be created. Changing this forces a new API Management Gateway resource to be created.

  • resource_group_name - (Required) The name of the Resource Group in which the API Management Gateway exists.

  • location_data - (Required) A location_data block as documented below.

  • description - (Optional) The description of the API Management Gateway.

A location_data block supports the following:

  • name - (Required) A canonical name for the geographic or physical location.

  • city - (Optional) The city or locality where the resource is located.

  • district - (Optional) The district, state, or province where the resource is located.

  • region - (Optional) The country or region where the resource is located.

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the API Management Gateway.

>> from Terraform Registry

Explanation in Terraform Registry

Manages an API Management Gateway.

>> from Terraform Registry

Microsoft.ApiManagement/service/gateways (Azure Resource Manager)

The service/gateways in Microsoft.ApiManagement can be configured in Azure Resource Manager with the resource name Microsoft.ApiManagement/service/gateways. 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

    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

  • properties required
      • description optional - string

        Gateway description

      • locationData optional
          • city optional - string

            The city or locality where the resource is located.

          • countryOrRegion optional - string

            The country or region where the resource is located.

          • district optional - string

            The district, state, or province where the resource is located.

          • name required - string

            A canonical name for the geographic or physical location.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure API Management Resources

Frequently asked questions

What is Azure API Management Gateway?

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

security-icon

Automate config file reviews on your commits

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

Table of Contents