Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

GatewayHostnameConfiguration

Gateway hostname configuration details. API Version: 2020-12-01.

Example Usage

ApiManagementCreateGatewayHostnameConfiguration

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var gatewayHostnameConfiguration = new AzureNative.ApiManagement.GatewayHostnameConfiguration("gatewayHostnameConfiguration", new AzureNative.ApiManagement.GatewayHostnameConfigurationArgs
        {
            CertificateId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
            GatewayId = "gw1",
            HcId = "default",
            Hostname = "*",
            Http2Enabled = true,
            NegotiateClientCertificate = false,
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
            Tls10Enabled = false,
            Tls11Enabled = false,
        });
    }

}
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewGatewayHostnameConfiguration(ctx, "gatewayHostnameConfiguration", &apimanagement.GatewayHostnameConfigurationArgs{
			CertificateId:              pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1"),
			GatewayId:                  pulumi.String("gw1"),
			HcId:                       pulumi.String("default"),
			Hostname:                   pulumi.String("*"),
			Http2Enabled:               pulumi.Bool(true),
			NegotiateClientCertificate: pulumi.Bool(false),
			ResourceGroupName:          pulumi.String("rg1"),
			ServiceName:                pulumi.String("apimService1"),
			Tls10Enabled:               pulumi.Bool(false),
			Tls11Enabled:               pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
        var gatewayHostnameConfiguration = new GatewayHostnameConfiguration("gatewayHostnameConfiguration", GatewayHostnameConfigurationArgs.builder()        
            .certificateId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1")
            .gatewayId("gw1")
            .hcId("default")
            .hostname("*")
            .http2Enabled(true)
            .negotiateClientCertificate(false)
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .tls10Enabled(false)
            .tls11Enabled(false)
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

gateway_hostname_configuration = azure_native.apimanagement.GatewayHostnameConfiguration("gatewayHostnameConfiguration",
    certificate_id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    gateway_id="gw1",
    hc_id="default",
    hostname="*",
    http2_enabled=True,
    negotiate_client_certificate=False,
    resource_group_name="rg1",
    service_name="apimService1",
    tls10_enabled=False,
    tls11_enabled=False)
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const gatewayHostnameConfiguration = new azure_native.apimanagement.GatewayHostnameConfiguration("gatewayHostnameConfiguration", {
    certificateId: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    gatewayId: "gw1",
    hcId: "default",
    hostname: "*",
    http2Enabled: true,
    negotiateClientCertificate: false,
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    tls10Enabled: false,
    tls11Enabled: false,
});
resources:
  gatewayHostnameConfiguration:
    type: azure-native:apimanagement:GatewayHostnameConfiguration
    properties:
      certificateId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1
      gatewayId: gw1
      hcId: default
      hostname: '*'
      http2Enabled: true
      negotiateClientCertificate: false
      resourceGroupName: rg1
      serviceName: apimService1
      tls10Enabled: false
      tls11Enabled: false

Create a GatewayHostnameConfiguration Resource

new GatewayHostnameConfiguration(name: string, args: GatewayHostnameConfigurationArgs, opts?: CustomResourceOptions);
@overload
def GatewayHostnameConfiguration(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 certificate_id: Optional[str] = None,
                                 gateway_id: Optional[str] = None,
                                 hc_id: Optional[str] = None,
                                 hostname: Optional[str] = None,
                                 http2_enabled: Optional[bool] = None,
                                 negotiate_client_certificate: Optional[bool] = None,
                                 resource_group_name: Optional[str] = None,
                                 service_name: Optional[str] = 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-native: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:

GatewayId string

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

CertificateId string

Identifier of Certificate entity that will be used for TLS connection establishment

HcId string

Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

Hostname string

Hostname value. Supports valid domain name, partial or full wildcard

Http2Enabled bool

Specifies if HTTP/2.0 is supported

NegotiateClientCertificate bool

Determines whether gateway requests client certificate

Tls10Enabled bool

Specifies if TLS 1.0 is supported

Tls11Enabled bool

Specifies if TLS 1.1 is supported

GatewayId string

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

CertificateId string

Identifier of Certificate entity that will be used for TLS connection establishment

HcId string

Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

Hostname string

Hostname value. Supports valid domain name, partial or full wildcard

Http2Enabled bool

Specifies if HTTP/2.0 is supported

NegotiateClientCertificate bool

Determines whether gateway requests client certificate

Tls10Enabled bool

Specifies if TLS 1.0 is supported

Tls11Enabled bool

Specifies if TLS 1.1 is supported

gatewayId String

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

certificateId String

Identifier of Certificate entity that will be used for TLS connection establishment

hcId String

Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

hostname String

Hostname value. Supports valid domain name, partial or full wildcard

http2Enabled Boolean

Specifies if HTTP/2.0 is supported

negotiateClientCertificate Boolean

Determines whether gateway requests client certificate

tls10Enabled Boolean

Specifies if TLS 1.0 is supported

tls11Enabled Boolean

Specifies if TLS 1.1 is supported

gatewayId string

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

certificateId string

Identifier of Certificate entity that will be used for TLS connection establishment

hcId string

Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

hostname string

Hostname value. Supports valid domain name, partial or full wildcard

http2Enabled boolean

Specifies if HTTP/2.0 is supported

negotiateClientCertificate boolean

Determines whether gateway requests client certificate

tls10Enabled boolean

Specifies if TLS 1.0 is supported

tls11Enabled boolean

Specifies if TLS 1.1 is supported

gateway_id str

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

resource_group_name str

The name of the resource group.

service_name str

The name of the API Management service.

certificate_id str

Identifier of Certificate entity that will be used for TLS connection establishment

hc_id str

Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

hostname str

Hostname value. Supports valid domain name, partial or full wildcard

http2_enabled bool

Specifies if HTTP/2.0 is supported

negotiate_client_certificate bool

Determines whether gateway requests client certificate

tls10_enabled bool

Specifies if TLS 1.0 is supported

tls11_enabled bool

Specifies if TLS 1.1 is supported

gatewayId String

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

certificateId String

Identifier of Certificate entity that will be used for TLS connection establishment

hcId String

Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

hostname String

Hostname value. Supports valid domain name, partial or full wildcard

http2Enabled Boolean

Specifies if HTTP/2.0 is supported

negotiateClientCertificate Boolean

Determines whether gateway requests client certificate

tls10Enabled Boolean

Specifies if TLS 1.0 is supported

tls11Enabled Boolean

Specifies if 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.

Name string

Resource name.

Type string

Resource type for API Management resource.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name.

Type string

Resource type for API Management resource.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

type String

Resource type for API Management resource.

id string

The provider-assigned unique ID for this managed resource.

name string

Resource name.

type string

Resource type for API Management resource.

id str

The provider-assigned unique ID for this managed resource.

name str

Resource name.

type str

Resource type for API Management resource.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

type String

Resource type for API Management resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:GatewayHostnameConfiguration default /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0