Top / Microsoft Azure / Azure API Management / Gateway API

Azure API Management Gateway API

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

The Gateway API in API Management can be configured in Terraform with the resource name azurerm_api_management_gateway_api. 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:

  • gateway_id - (Required) The Identifier for the API Management Gateway. Changing this forces a new API Management Gateway API to be created.

  • api_id - (Required) The Identifier of the API Management API within the API Management Service. Changing this forces a new API Management Gateway API to be created.

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

  • id - The ID of the API Management Gateway API.

>> from Terraform Registry

Explanation in Terraform Registry

Manages a API Management Gateway API.

>> from Terraform Registry

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

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

    API identifier. Must be unique in the current API Management service instance.

  • properties required
      • provisioningState optional - string

        Provisioning state.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure API Management Resources

Frequently asked questions

What is Azure API Management Gateway API?

Azure API Management Gateway API 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