Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. GatewayHostNameConfiguration

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.GatewayHostNameConfiguration

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an API Management Gateway Host Name Configuration.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as std from "@pulumi/std";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleService = new azure.apimanagement.Service("example", {
    name: "example-apim",
    location: example.location,
    resourceGroupName: example.name,
    publisherName: "pub1",
    publisherEmail: "pub1@email.com",
    skuName: "Consumption_0",
});
const exampleGateway = new azure.apimanagement.Gateway("example", {
    name: "example-gateway",
    apiManagementId: exampleService.id,
    description: "Example API Management gateway",
    locationData: {
        name: "example name",
        city: "example city",
        district: "example district",
        region: "example region",
    },
});
const exampleCertificate = new azure.apimanagement.Certificate("example", {
    name: "example-cert",
    apiManagementName: exampleService.name,
    resourceGroupName: example.name,
    data: std.filebase64({
        input: "example.pfx",
    }).then(invoke => invoke.result),
});
const exampleGatewayHostNameConfiguration = new azure.apimanagement.GatewayHostNameConfiguration("example", {
    name: "example-host-name-configuration",
    apiManagementId: exampleService.id,
    gatewayName: exampleGateway.name,
    certificateId: exampleCertificate.id,
    hostName: "example-host-name",
    requestClientCertificateEnabled: true,
    http2Enabled: true,
    tls10Enabled: true,
    tls11Enabled: false,
});
Copy
import pulumi
import pulumi_azure as azure
import pulumi_std as std

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_service = azure.apimanagement.Service("example",
    name="example-apim",
    location=example.location,
    resource_group_name=example.name,
    publisher_name="pub1",
    publisher_email="pub1@email.com",
    sku_name="Consumption_0")
example_gateway = azure.apimanagement.Gateway("example",
    name="example-gateway",
    api_management_id=example_service.id,
    description="Example API Management gateway",
    location_data={
        "name": "example name",
        "city": "example city",
        "district": "example district",
        "region": "example region",
    })
example_certificate = azure.apimanagement.Certificate("example",
    name="example-cert",
    api_management_name=example_service.name,
    resource_group_name=example.name,
    data=std.filebase64(input="example.pfx").result)
example_gateway_host_name_configuration = azure.apimanagement.GatewayHostNameConfiguration("example",
    name="example-host-name-configuration",
    api_management_id=example_service.id,
    gateway_name=example_gateway.name,
    certificate_id=example_certificate.id,
    host_name="example-host-name",
    request_client_certificate_enabled=True,
    http2_enabled=True,
    tls10_enabled=True,
    tls11_enabled=False)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
			Name:              pulumi.String("example-apim"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			PublisherName:     pulumi.String("pub1"),
			PublisherEmail:    pulumi.String("pub1@email.com"),
			SkuName:           pulumi.String("Consumption_0"),
		})
		if err != nil {
			return err
		}
		exampleGateway, err := apimanagement.NewGateway(ctx, "example", &apimanagement.GatewayArgs{
			Name:            pulumi.String("example-gateway"),
			ApiManagementId: exampleService.ID(),
			Description:     pulumi.String("Example API Management gateway"),
			LocationData: &apimanagement.GatewayLocationDataArgs{
				Name:     pulumi.String("example name"),
				City:     pulumi.String("example city"),
				District: pulumi.String("example district"),
				Region:   pulumi.String("example region"),
			},
		})
		if err != nil {
			return err
		}
		invokeFilebase64, err := std.Filebase64(ctx, &std.Filebase64Args{
			Input: "example.pfx",
		}, nil)
		if err != nil {
			return err
		}
		exampleCertificate, err := apimanagement.NewCertificate(ctx, "example", &apimanagement.CertificateArgs{
			Name:              pulumi.String("example-cert"),
			ApiManagementName: exampleService.Name,
			ResourceGroupName: example.Name,
			Data:              pulumi.String(invokeFilebase64.Result),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewGatewayHostNameConfiguration(ctx, "example", &apimanagement.GatewayHostNameConfigurationArgs{
			Name:                            pulumi.String("example-host-name-configuration"),
			ApiManagementId:                 exampleService.ID(),
			GatewayName:                     exampleGateway.Name,
			CertificateId:                   exampleCertificate.ID(),
			HostName:                        pulumi.String("example-host-name"),
			RequestClientCertificateEnabled: pulumi.Bool(true),
			Http2Enabled:                    pulumi.Bool(true),
			Tls10Enabled:                    pulumi.Bool(true),
			Tls11Enabled:                    pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleService = new Azure.ApiManagement.Service("example", new()
    {
        Name = "example-apim",
        Location = example.Location,
        ResourceGroupName = example.Name,
        PublisherName = "pub1",
        PublisherEmail = "pub1@email.com",
        SkuName = "Consumption_0",
    });

    var exampleGateway = new Azure.ApiManagement.Gateway("example", new()
    {
        Name = "example-gateway",
        ApiManagementId = exampleService.Id,
        Description = "Example API Management gateway",
        LocationData = new Azure.ApiManagement.Inputs.GatewayLocationDataArgs
        {
            Name = "example name",
            City = "example city",
            District = "example district",
            Region = "example region",
        },
    });

    var exampleCertificate = new Azure.ApiManagement.Certificate("example", new()
    {
        Name = "example-cert",
        ApiManagementName = exampleService.Name,
        ResourceGroupName = example.Name,
        Data = Std.Filebase64.Invoke(new()
        {
            Input = "example.pfx",
        }).Apply(invoke => invoke.Result),
    });

    var exampleGatewayHostNameConfiguration = new Azure.ApiManagement.GatewayHostNameConfiguration("example", new()
    {
        Name = "example-host-name-configuration",
        ApiManagementId = exampleService.Id,
        GatewayName = exampleGateway.Name,
        CertificateId = exampleCertificate.Id,
        HostName = "example-host-name",
        RequestClientCertificateEnabled = true,
        Http2Enabled = true,
        Tls10Enabled = true,
        Tls11Enabled = false,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import com.pulumi.azure.apimanagement.Gateway;
import com.pulumi.azure.apimanagement.GatewayArgs;
import com.pulumi.azure.apimanagement.inputs.GatewayLocationDataArgs;
import com.pulumi.azure.apimanagement.Certificate;
import com.pulumi.azure.apimanagement.CertificateArgs;
import com.pulumi.azure.apimanagement.GatewayHostNameConfiguration;
import com.pulumi.azure.apimanagement.GatewayHostNameConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("example-apim")
            .location(example.location())
            .resourceGroupName(example.name())
            .publisherName("pub1")
            .publisherEmail("pub1@email.com")
            .skuName("Consumption_0")
            .build());

        var exampleGateway = new Gateway("exampleGateway", GatewayArgs.builder()
            .name("example-gateway")
            .apiManagementId(exampleService.id())
            .description("Example API Management gateway")
            .locationData(GatewayLocationDataArgs.builder()
                .name("example name")
                .city("example city")
                .district("example district")
                .region("example region")
                .build())
            .build());

        var exampleCertificate = new Certificate("exampleCertificate", CertificateArgs.builder()
            .name("example-cert")
            .apiManagementName(exampleService.name())
            .resourceGroupName(example.name())
            .data(StdFunctions.filebase64(Filebase64Args.builder()
                .input("example.pfx")
                .build()).result())
            .build());

        var exampleGatewayHostNameConfiguration = new GatewayHostNameConfiguration("exampleGatewayHostNameConfiguration", GatewayHostNameConfigurationArgs.builder()
            .name("example-host-name-configuration")
            .apiManagementId(exampleService.id())
            .gatewayName(exampleGateway.name())
            .certificateId(exampleCertificate.id())
            .hostName("example-host-name")
            .requestClientCertificateEnabled(true)
            .http2Enabled(true)
            .tls10Enabled(true)
            .tls11Enabled(false)
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleService:
    type: azure:apimanagement:Service
    name: example
    properties:
      name: example-apim
      location: ${example.location}
      resourceGroupName: ${example.name}
      publisherName: pub1
      publisherEmail: pub1@email.com
      skuName: Consumption_0
  exampleGateway:
    type: azure:apimanagement:Gateway
    name: example
    properties:
      name: example-gateway
      apiManagementId: ${exampleService.id}
      description: Example API Management gateway
      locationData:
        name: example name
        city: example city
        district: example district
        region: example region
  exampleCertificate:
    type: azure:apimanagement:Certificate
    name: example
    properties:
      name: example-cert
      apiManagementName: ${exampleService.name}
      resourceGroupName: ${example.name}
      data:
        fn::invoke:
          function: std:filebase64
          arguments:
            input: example.pfx
          return: result
  exampleGatewayHostNameConfiguration:
    type: azure:apimanagement:GatewayHostNameConfiguration
    name: example
    properties:
      name: example-host-name-configuration
      apiManagementId: ${exampleService.id}
      gatewayName: ${exampleGateway.name}
      certificateId: ${exampleCertificate.id}
      hostName: example-host-name
      requestClientCertificateEnabled: true
      http2Enabled: true
      tls10Enabled: true
      tls11Enabled: false
Copy

Create GatewayHostNameConfiguration Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new GatewayHostNameConfiguration(name: string, args: GatewayHostNameConfigurationArgs, opts?: CustomResourceOptions);
@overload
def GatewayHostNameConfiguration(resource_name: str,
                                 args: GatewayHostNameConfigurationArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def GatewayHostNameConfiguration(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 api_management_id: Optional[str] = None,
                                 certificate_id: Optional[str] = None,
                                 gateway_name: Optional[str] = None,
                                 host_name: Optional[str] = None,
                                 http2_enabled: Optional[bool] = None,
                                 name: Optional[str] = None,
                                 request_client_certificate_enabled: Optional[bool] = None,
                                 tls10_enabled: Optional[bool] = None,
                                 tls11_enabled: Optional[bool] = None)
func NewGatewayHostNameConfiguration(ctx *Context, name string, args GatewayHostNameConfigurationArgs, opts ...ResourceOption) (*GatewayHostNameConfiguration, error)
public GatewayHostNameConfiguration(string name, GatewayHostNameConfigurationArgs args, CustomResourceOptions? opts = null)
public GatewayHostNameConfiguration(String name, GatewayHostNameConfigurationArgs args)
public GatewayHostNameConfiguration(String name, GatewayHostNameConfigurationArgs args, CustomResourceOptions options)

type: azure:apimanagement:GatewayHostNameConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayHostNameConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayHostNameConfigurationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayHostNameConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayHostNameConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayHostNameConfigurationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var gatewayHostNameConfigurationResource = new Azure.ApiManagement.GatewayHostNameConfiguration("gatewayHostNameConfigurationResource", new()
{
    ApiManagementId = "string",
    CertificateId = "string",
    GatewayName = "string",
    HostName = "string",
    Http2Enabled = false,
    Name = "string",
    RequestClientCertificateEnabled = false,
    Tls10Enabled = false,
    Tls11Enabled = false,
});
Copy
example, err := apimanagement.NewGatewayHostNameConfiguration(ctx, "gatewayHostNameConfigurationResource", &apimanagement.GatewayHostNameConfigurationArgs{
	ApiManagementId:                 pulumi.String("string"),
	CertificateId:                   pulumi.String("string"),
	GatewayName:                     pulumi.String("string"),
	HostName:                        pulumi.String("string"),
	Http2Enabled:                    pulumi.Bool(false),
	Name:                            pulumi.String("string"),
	RequestClientCertificateEnabled: pulumi.Bool(false),
	Tls10Enabled:                    pulumi.Bool(false),
	Tls11Enabled:                    pulumi.Bool(false),
})
Copy
var gatewayHostNameConfigurationResource = new GatewayHostNameConfiguration("gatewayHostNameConfigurationResource", GatewayHostNameConfigurationArgs.builder()
    .apiManagementId("string")
    .certificateId("string")
    .gatewayName("string")
    .hostName("string")
    .http2Enabled(false)
    .name("string")
    .requestClientCertificateEnabled(false)
    .tls10Enabled(false)
    .tls11Enabled(false)
    .build());
Copy
gateway_host_name_configuration_resource = azure.apimanagement.GatewayHostNameConfiguration("gatewayHostNameConfigurationResource",
    api_management_id="string",
    certificate_id="string",
    gateway_name="string",
    host_name="string",
    http2_enabled=False,
    name="string",
    request_client_certificate_enabled=False,
    tls10_enabled=False,
    tls11_enabled=False)
Copy
const gatewayHostNameConfigurationResource = new azure.apimanagement.GatewayHostNameConfiguration("gatewayHostNameConfigurationResource", {
    apiManagementId: "string",
    certificateId: "string",
    gatewayName: "string",
    hostName: "string",
    http2Enabled: false,
    name: "string",
    requestClientCertificateEnabled: false,
    tls10Enabled: false,
    tls11Enabled: false,
});
Copy
type: azure:apimanagement:GatewayHostNameConfiguration
properties:
    apiManagementId: string
    certificateId: string
    gatewayName: string
    hostName: string
    http2Enabled: false
    name: string
    requestClientCertificateEnabled: false
    tls10Enabled: false
    tls11Enabled: false
Copy

GatewayHostNameConfiguration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The GatewayHostNameConfiguration resource accepts the following input properties:

ApiManagementId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the API Management Service. Changing this forces a new resource to be created.
CertificateId This property is required. string
The certificate ID to be used for TLS connection establishment.
GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management Gateway. Changing this forces a new resource to be created.
HostName This property is required. string
The host name to use for the API Management Gateway Host Name Configuration.
Http2Enabled bool
Whether HTTP/2.0 is supported. Defaults to true.
Name Changes to this property will trigger replacement. string
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
RequestClientCertificateEnabled bool
Whether the API Management Gateway requests a client certificate.
Tls10Enabled bool
Whether TLS 1.0 is supported.
Tls11Enabled bool
Whether TLS 1.1 is supported.
ApiManagementId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the API Management Service. Changing this forces a new resource to be created.
CertificateId This property is required. string
The certificate ID to be used for TLS connection establishment.
GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management Gateway. Changing this forces a new resource to be created.
HostName This property is required. string
The host name to use for the API Management Gateway Host Name Configuration.
Http2Enabled bool
Whether HTTP/2.0 is supported. Defaults to true.
Name Changes to this property will trigger replacement. string
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
RequestClientCertificateEnabled bool
Whether the API Management Gateway requests a client certificate.
Tls10Enabled bool
Whether TLS 1.0 is supported.
Tls11Enabled bool
Whether TLS 1.1 is supported.
apiManagementId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the API Management Service. Changing this forces a new resource to be created.
certificateId This property is required. String
The certificate ID to be used for TLS connection establishment.
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management Gateway. Changing this forces a new resource to be created.
hostName This property is required. String
The host name to use for the API Management Gateway Host Name Configuration.
http2Enabled Boolean
Whether HTTP/2.0 is supported. Defaults to true.
name Changes to this property will trigger replacement. String
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
requestClientCertificateEnabled Boolean
Whether the API Management Gateway requests a client certificate.
tls10Enabled Boolean
Whether TLS 1.0 is supported.
tls11Enabled Boolean
Whether TLS 1.1 is supported.
apiManagementId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the API Management Service. Changing this forces a new resource to be created.
certificateId This property is required. string
The certificate ID to be used for TLS connection establishment.
gatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management Gateway. Changing this forces a new resource to be created.
hostName This property is required. string
The host name to use for the API Management Gateway Host Name Configuration.
http2Enabled boolean
Whether HTTP/2.0 is supported. Defaults to true.
name Changes to this property will trigger replacement. string
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
requestClientCertificateEnabled boolean
Whether the API Management Gateway requests a client certificate.
tls10Enabled boolean
Whether TLS 1.0 is supported.
tls11Enabled boolean
Whether TLS 1.1 is supported.
api_management_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the API Management Service. Changing this forces a new resource to be created.
certificate_id This property is required. str
The certificate ID to be used for TLS connection establishment.
gateway_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management Gateway. Changing this forces a new resource to be created.
host_name This property is required. str
The host name to use for the API Management Gateway Host Name Configuration.
http2_enabled bool
Whether HTTP/2.0 is supported. Defaults to true.
name Changes to this property will trigger replacement. str
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
request_client_certificate_enabled bool
Whether the API Management Gateway requests a client certificate.
tls10_enabled bool
Whether TLS 1.0 is supported.
tls11_enabled bool
Whether TLS 1.1 is supported.
apiManagementId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the API Management Service. Changing this forces a new resource to be created.
certificateId This property is required. String
The certificate ID to be used for TLS connection establishment.
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management Gateway. Changing this forces a new resource to be created.
hostName This property is required. String
The host name to use for the API Management Gateway Host Name Configuration.
http2Enabled Boolean
Whether HTTP/2.0 is supported. Defaults to true.
name Changes to this property will trigger replacement. String
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
requestClientCertificateEnabled Boolean
Whether the API Management Gateway requests a client certificate.
tls10Enabled Boolean
Whether TLS 1.0 is supported.
tls11Enabled Boolean
Whether TLS 1.1 is supported.

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayHostNameConfiguration resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing GatewayHostNameConfiguration Resource

Get an existing GatewayHostNameConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GatewayHostNameConfigurationState, opts?: CustomResourceOptions): GatewayHostNameConfiguration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_id: Optional[str] = None,
        certificate_id: Optional[str] = None,
        gateway_name: Optional[str] = None,
        host_name: Optional[str] = None,
        http2_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        request_client_certificate_enabled: Optional[bool] = None,
        tls10_enabled: Optional[bool] = None,
        tls11_enabled: Optional[bool] = None) -> GatewayHostNameConfiguration
func GetGatewayHostNameConfiguration(ctx *Context, name string, id IDInput, state *GatewayHostNameConfigurationState, opts ...ResourceOption) (*GatewayHostNameConfiguration, error)
public static GatewayHostNameConfiguration Get(string name, Input<string> id, GatewayHostNameConfigurationState? state, CustomResourceOptions? opts = null)
public static GatewayHostNameConfiguration get(String name, Output<String> id, GatewayHostNameConfigurationState state, CustomResourceOptions options)
resources:  _:    type: azure:apimanagement:GatewayHostNameConfiguration    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApiManagementId Changes to this property will trigger replacement. string
The ID of the API Management Service. Changing this forces a new resource to be created.
CertificateId string
The certificate ID to be used for TLS connection establishment.
GatewayName Changes to this property will trigger replacement. string
The name of the API Management Gateway. Changing this forces a new resource to be created.
HostName string
The host name to use for the API Management Gateway Host Name Configuration.
Http2Enabled bool
Whether HTTP/2.0 is supported. Defaults to true.
Name Changes to this property will trigger replacement. string
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
RequestClientCertificateEnabled bool
Whether the API Management Gateway requests a client certificate.
Tls10Enabled bool
Whether TLS 1.0 is supported.
Tls11Enabled bool
Whether TLS 1.1 is supported.
ApiManagementId Changes to this property will trigger replacement. string
The ID of the API Management Service. Changing this forces a new resource to be created.
CertificateId string
The certificate ID to be used for TLS connection establishment.
GatewayName Changes to this property will trigger replacement. string
The name of the API Management Gateway. Changing this forces a new resource to be created.
HostName string
The host name to use for the API Management Gateway Host Name Configuration.
Http2Enabled bool
Whether HTTP/2.0 is supported. Defaults to true.
Name Changes to this property will trigger replacement. string
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
RequestClientCertificateEnabled bool
Whether the API Management Gateway requests a client certificate.
Tls10Enabled bool
Whether TLS 1.0 is supported.
Tls11Enabled bool
Whether TLS 1.1 is supported.
apiManagementId Changes to this property will trigger replacement. String
The ID of the API Management Service. Changing this forces a new resource to be created.
certificateId String
The certificate ID to be used for TLS connection establishment.
gatewayName Changes to this property will trigger replacement. String
The name of the API Management Gateway. Changing this forces a new resource to be created.
hostName String
The host name to use for the API Management Gateway Host Name Configuration.
http2Enabled Boolean
Whether HTTP/2.0 is supported. Defaults to true.
name Changes to this property will trigger replacement. String
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
requestClientCertificateEnabled Boolean
Whether the API Management Gateway requests a client certificate.
tls10Enabled Boolean
Whether TLS 1.0 is supported.
tls11Enabled Boolean
Whether TLS 1.1 is supported.
apiManagementId Changes to this property will trigger replacement. string
The ID of the API Management Service. Changing this forces a new resource to be created.
certificateId string
The certificate ID to be used for TLS connection establishment.
gatewayName Changes to this property will trigger replacement. string
The name of the API Management Gateway. Changing this forces a new resource to be created.
hostName string
The host name to use for the API Management Gateway Host Name Configuration.
http2Enabled boolean
Whether HTTP/2.0 is supported. Defaults to true.
name Changes to this property will trigger replacement. string
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
requestClientCertificateEnabled boolean
Whether the API Management Gateway requests a client certificate.
tls10Enabled boolean
Whether TLS 1.0 is supported.
tls11Enabled boolean
Whether TLS 1.1 is supported.
api_management_id Changes to this property will trigger replacement. str
The ID of the API Management Service. Changing this forces a new resource to be created.
certificate_id str
The certificate ID to be used for TLS connection establishment.
gateway_name Changes to this property will trigger replacement. str
The name of the API Management Gateway. Changing this forces a new resource to be created.
host_name str
The host name to use for the API Management Gateway Host Name Configuration.
http2_enabled bool
Whether HTTP/2.0 is supported. Defaults to true.
name Changes to this property will trigger replacement. str
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
request_client_certificate_enabled bool
Whether the API Management Gateway requests a client certificate.
tls10_enabled bool
Whether TLS 1.0 is supported.
tls11_enabled bool
Whether TLS 1.1 is supported.
apiManagementId Changes to this property will trigger replacement. String
The ID of the API Management Service. Changing this forces a new resource to be created.
certificateId String
The certificate ID to be used for TLS connection establishment.
gatewayName Changes to this property will trigger replacement. String
The name of the API Management Gateway. Changing this forces a new resource to be created.
hostName String
The host name to use for the API Management Gateway Host Name Configuration.
http2Enabled Boolean
Whether HTTP/2.0 is supported. Defaults to true.
name Changes to this property will trigger replacement. String
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
requestClientCertificateEnabled Boolean
Whether the API Management Gateway requests a client certificate.
tls10Enabled Boolean
Whether TLS 1.0 is supported.
tls11Enabled Boolean
Whether TLS 1.1 is supported.

Import

API Management Gateway Host Name Configuration can be imported using the resource id, e.g.

$ pulumi import azure:apimanagement/gatewayHostNameConfiguration:GatewayHostNameConfiguration example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/gateways/gateway1/hostnameConfigurations/hc1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure