Skip to content

Data Source: azurermApiManagementGateway

Use this data source to access information about an existing API Management Gateway.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const dataAzurermApiManagementExample =
  new azurerm.dataAzurermApiManagement.DataAzurermApiManagement(
    this,
    "example",
    {
      name: "example-apim",
      resource_group_name: "example-rg",
    }
  );
const dataAzurermApiManagementGatewayExample =
  new azurerm.dataAzurermApiManagementGateway.DataAzurermApiManagementGateway(
    this,
    "example_1",
    {
      api_management_id: dataAzurermApiManagementExample.id,
      name: "example-api-gateway",
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
dataAzurermApiManagementGatewayExample.overrideLogicalId("example");

Arguments Reference

The following arguments are supported:

  • name - The name of the API Management Gateway.

  • apiManagementId - The ID of the API Management Service in which the Gateway exists.

Attributes Reference

  • id - The ID of the API Management Gateway.

  • locationData - A locationData block as documented below.

  • description - The description of the API Management Gateway.


A locationData block exports the following:

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

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

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

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


Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the API Management Gateway.