Azure Classic v5.43.0, May 6 23
Azure Classic v5.43.0, May 6 23
azure.apimanagement.GatewayHostNameConfiguration
Explore with Pulumi AI
Manages an API Management Gateway Host Name Configuration.
Example Usage
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
private static string ReadFileBase64(string path) {
return Convert.ToBase64String(System.Text.Encoding.UTF8.GetBytes(File.ReadAllText(path)));
}
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleService = new Azure.ApiManagement.Service("exampleService", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
PublisherName = "pub1",
PublisherEmail = "pub1@email.com",
SkuName = "Consumption_0",
});
var exampleGateway = new Azure.ApiManagement.Gateway("exampleGateway", new()
{
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("exampleCertificate", new()
{
ApiManagementName = exampleService.Name,
ResourceGroupName = exampleResourceGroup.Name,
Data = ReadFileBase64("example.pfx"),
});
var exampleGatewayHostNameConfiguration = new Azure.ApiManagement.GatewayHostNameConfiguration("exampleGatewayHostNameConfiguration", new()
{
ApiManagementId = exampleService.Id,
GatewayName = exampleGateway.Name,
CertificateId = exampleCertificate.Id,
HostName = "example-host-name",
RequestClientCertificateEnabled = true,
Http2Enabled = true,
Tls10Enabled = true,
Tls11Enabled = false,
});
});
package main
import (
"encoding/base64"
"os"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func filebase64OrPanic(path string) pulumi.StringPtrInput {
if fileData, err := os.ReadFile(path); err == nil {
return pulumi.String(base64.StdEncoding.EncodeToString(fileData[:]))
} else {
panic(err.Error())
}
}
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.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, "exampleGateway", &apimanagement.GatewayArgs{
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
}
exampleCertificate, err := apimanagement.NewCertificate(ctx, "exampleCertificate", &apimanagement.CertificateArgs{
ApiManagementName: exampleService.Name,
ResourceGroupName: exampleResourceGroup.Name,
Data: filebase64OrPanic("example.pfx"),
})
if err != nil {
return err
}
_, err = apimanagement.NewGatewayHostNameConfiguration(ctx, "exampleGatewayHostNameConfiguration", &apimanagement.GatewayHostNameConfigurationArgs{
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.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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleService = new Service("exampleService", ServiceArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.publisherName("pub1")
.publisherEmail("pub1@email.com")
.skuName("Consumption_0")
.build());
var exampleGateway = new Gateway("exampleGateway", GatewayArgs.builder()
.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()
.apiManagementName(exampleService.name())
.resourceGroupName(exampleResourceGroup.name())
.data(Base64.getEncoder().encodeToString(Files.readAllBytes(Paths.get("example.pfx"))))
.build());
var exampleGatewayHostNameConfiguration = new GatewayHostNameConfiguration("exampleGatewayHostNameConfiguration", GatewayHostNameConfigurationArgs.builder()
.apiManagementId(exampleService.id())
.gatewayName(exampleGateway.name())
.certificateId(exampleCertificate.id())
.hostName("example-host-name")
.requestClientCertificateEnabled(true)
.http2Enabled(true)
.tls10Enabled(true)
.tls11Enabled(false)
.build());
}
}
import pulumi
import base64
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
publisher_name="pub1",
publisher_email="pub1@email.com",
sku_name="Consumption_0")
example_gateway = azure.apimanagement.Gateway("exampleGateway",
api_management_id=example_service.id,
description="Example API Management gateway",
location_data=azure.apimanagement.GatewayLocationDataArgs(
name="example name",
city="example city",
district="example district",
region="example region",
))
example_certificate = azure.apimanagement.Certificate("exampleCertificate",
api_management_name=example_service.name,
resource_group_name=example_resource_group.name,
data=(lambda path: base64.b64encode(open(path).read().encode()).decode())("example.pfx"))
example_gateway_host_name_configuration = azure.apimanagement.GatewayHostNameConfiguration("exampleGatewayHostNameConfiguration",
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)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as fs from "fs";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
publisherName: "pub1",
publisherEmail: "pub1@email.com",
skuName: "Consumption_0",
});
const exampleGateway = new azure.apimanagement.Gateway("exampleGateway", {
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("exampleCertificate", {
apiManagementName: exampleService.name,
resourceGroupName: exampleResourceGroup.name,
data: Buffer.from(fs.readFileSync("example.pfx"), 'binary').toString('base64'),
});
const exampleGatewayHostNameConfiguration = new azure.apimanagement.GatewayHostNameConfiguration("exampleGatewayHostNameConfiguration", {
apiManagementId: exampleService.id,
gatewayName: exampleGateway.name,
certificateId: exampleCertificate.id,
hostName: "example-host-name",
requestClientCertificateEnabled: true,
http2Enabled: true,
tls10Enabled: true,
tls11Enabled: false,
});
Coming soon!
Create GatewayHostNameConfiguration Resource
new GatewayHostNameConfiguration(name: string, args: GatewayHostNameConfigurationArgs, opts?: CustomResourceOptions);
@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)
@overload
def GatewayHostNameConfiguration(resource_name: str,
args: GatewayHostNameConfigurationArgs,
opts: Optional[ResourceOptions] = 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.
- name string
- The unique name of the resource.
- args GatewayHostNameConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args GatewayHostNameConfigurationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayHostNameConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayHostNameConfigurationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
The GatewayHostNameConfiguration resource accepts the following input properties:
- Api
Management stringId The ID of the API Management Service. Changing this forces a new resource to be created.
- Certificate
Id string The certificate ID to be used for TLS connection establishment.
- Gateway
Name string The name of the API Management Gateway. Changing this forces a new resource to be created.
- Host
Name 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 string
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
- Request
Client boolCertificate Enabled 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.
- Api
Management stringId The ID of the API Management Service. Changing this forces a new resource to be created.
- Certificate
Id string The certificate ID to be used for TLS connection establishment.
- Gateway
Name string The name of the API Management Gateway. Changing this forces a new resource to be created.
- Host
Name 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 string
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
- Request
Client boolCertificate Enabled 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.
- api
Management StringId The ID of the API Management Service. Changing this forces a new resource to be created.
- certificate
Id String The certificate ID to be used for TLS connection establishment.
- gateway
Name String The name of the API Management Gateway. Changing this forces a new resource to be created.
- host
Name 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 String
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
- request
Client BooleanCertificate Enabled 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 stringId The ID of the API Management Service. Changing this forces a new resource to be created.
- certificate
Id string The certificate ID to be used for TLS connection establishment.
- gateway
Name string The name of the API Management Gateway. Changing this forces a new resource to be created.
- host
Name 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 string
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
- request
Client booleanCertificate Enabled 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_ strid 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 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 str
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
- request_
client_ boolcertificate_ enabled 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.
- api
Management StringId The ID of the API Management Service. Changing this forces a new resource to be created.
- certificate
Id String The certificate ID to be used for TLS connection establishment.
- gateway
Name String The name of the API Management Gateway. Changing this forces a new resource to be created.
- host
Name 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 String
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
- request
Client BooleanCertificate Enabled 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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Api
Management stringId The ID of the API Management Service. Changing this forces a new resource to be created.
- Certificate
Id string The certificate ID to be used for TLS connection establishment.
- Gateway
Name string The name of the API Management Gateway. Changing this forces a new resource to be created.
- Host
Name 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 string
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
- Request
Client boolCertificate Enabled 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.
- Api
Management stringId The ID of the API Management Service. Changing this forces a new resource to be created.
- Certificate
Id string The certificate ID to be used for TLS connection establishment.
- Gateway
Name string The name of the API Management Gateway. Changing this forces a new resource to be created.
- Host
Name 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 string
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
- Request
Client boolCertificate Enabled 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.
- api
Management StringId The ID of the API Management Service. Changing this forces a new resource to be created.
- certificate
Id String The certificate ID to be used for TLS connection establishment.
- gateway
Name String The name of the API Management Gateway. Changing this forces a new resource to be created.
- host
Name 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 String
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
- request
Client BooleanCertificate Enabled 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 stringId The ID of the API Management Service. Changing this forces a new resource to be created.
- certificate
Id string The certificate ID to be used for TLS connection establishment.
- gateway
Name string The name of the API Management Gateway. Changing this forces a new resource to be created.
- host
Name 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 string
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
- request
Client booleanCertificate Enabled 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_ strid 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 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 str
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
- request_
client_ boolcertificate_ enabled 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.
- api
Management StringId The ID of the API Management Service. Changing this forces a new resource to be created.
- certificate
Id String The certificate ID to be used for TLS connection establishment.
- gateway
Name String The name of the API Management Gateway. Changing this forces a new resource to be created.
- host
Name 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 String
The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
- request
Client BooleanCertificate Enabled 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
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.