pulumi-azure-kotlin/com.pulumi.azure.apimanagement.kotlin/GatewayHostNameConfigurationArgs

GatewayHostNameConfigurationArgs

data class GatewayHostNameConfigurationArgs(val apiManagementId: Output<String>? = null, val certificateId: Output<String>? = null, val gatewayName: Output<String>? = null, val hostName: Output<String>? = null, val http2Enabled: Output<Boolean>? = null, val name: Output<String>? = null, val requestClientCertificateEnabled: Output<Boolean>? = null, val tls10Enabled: Output<Boolean>? = null, val tls11Enabled: Output<Boolean>? = null) : ConvertibleToJava<GatewayHostNameConfigurationArgs>

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,
});

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)

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,
    });
});

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
	})
}

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.std.StdFunctions;
import com.pulumi.std.inputs.Filebase64Args;
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());
    }
}

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

API Providers

This resource uses the following Azure API Providers:

Microsoft.ApiManagement: 2022-08-01

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

Constructors

GatewayHostNameConfigurationArgs

constructor(apiManagementId: Output<String>? = null, certificateId: Output<String>? = null, gatewayName: Output<String>? = null, hostName: Output<String>? = null, http2Enabled: Output<Boolean>? = null, name: Output<String>? = null, requestClientCertificateEnabled: Output<Boolean>? = null, tls10Enabled: Output<Boolean>? = null, tls11Enabled: Output<Boolean>? = null)