Skip to content

Data Source: azurermApiManagementGatewayHostNameConfiguration

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

Example Usage

import * as cdktf from "cdktf";
/*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-resources",
    }
  );
const dataAzurermApiManagementGatewayExample =
  new azurerm.dataAzurermApiManagementGateway.DataAzurermApiManagementGateway(
    this,
    "example_1",
    {
      api_management_id: "${data.azurerm_api_management.main.id}",
      name: "example-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");
const dataAzurermApiManagementGatewayHostNameConfigurationExample =
  new azurerm.dataAzurermApiManagementGatewayHostNameConfiguration.DataAzurermApiManagementGatewayHostNameConfiguration(
    this,
    "example_2",
    {
      api_management_id: dataAzurermApiManagementExample.id,
      gateway_name: dataAzurermApiManagementGatewayExample.name,
      name: "example-host-configuration",
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
dataAzurermApiManagementGatewayHostNameConfigurationExample.overrideLogicalId(
  "example"
);
new cdktf.TerraformOutput(this, "host_name", {
  value: dataAzurermApiManagementGatewayHostNameConfigurationExample.hostName,
});

Arguments Reference

The following arguments are supported:

  • apiManagementId - (Required) The ID of the API Management Service.

  • gatewayName - (Required) The name of the API Management Gateway.

*

  • name - (Required) The name of the API Management Gateway Host Name Configuration.

Attributes Reference

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

  • certificateId - The ID of the certificate used for TLS connection establishment.

  • hostName - The host name used for the API Management Gateway Host Name Configuration.

  • http2Enabled - Whether HTTP/2.0 is supported.

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

  • requestClientCertificateEnabled - Whether the API Management Gateway requests a client certificate.

  • tls10Enabled - Whether TLS 1.0 is supported.

  • tls11Enabled - Whether TLS 1.1 is supported.

Timeouts

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

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