CustomHostnameBinding

Manages a Hostname Binding within an App Service.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;
using Random = Pulumi.Random;

class MyStack : Stack
{
    public MyStack()
    {
        var server = new Random.RandomId("server", new Random.RandomIdArgs
        {
            Keepers = 
            {
                { "azi_id", 1 },
            },
            ByteLength = 8,
        });
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var examplePlan = new Azure.AppService.Plan("examplePlan", new Azure.AppService.PlanArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = new Azure.AppService.Inputs.PlanSkuArgs
            {
                Tier = "Standard",
                Size = "S1",
            },
        });
        var exampleAppService = new Azure.AppService.AppService("exampleAppService", new Azure.AppService.AppServiceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            AppServicePlanId = examplePlan.Id,
        });
        var exampleCustomHostnameBinding = new Azure.AppService.CustomHostnameBinding("exampleCustomHostnameBinding", new Azure.AppService.CustomHostnameBindingArgs
        {
            Hostname = "www.mywebsite.com",
            AppServiceName = exampleAppService.Name,
            ResourceGroupName = exampleResourceGroup.Name,
        });
    }

}

Coming soon!

import pulumi
import pulumi_azure as azure
import pulumi_random as random

server = random.RandomId("server",
    keepers={
        "azi_id": 1,
    },
    byte_length=8)
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_plan = azure.appservice.Plan("examplePlan",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku={
        "tier": "Standard",
        "size": "S1",
    })
example_app_service = azure.appservice.AppService("exampleAppService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    app_service_plan_id=example_plan.id)
example_custom_hostname_binding = azure.appservice.CustomHostnameBinding("exampleCustomHostnameBinding",
    hostname="www.mywebsite.com",
    app_service_name=example_app_service.name,
    resource_group_name=example_resource_group.name)

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

const server = new random.RandomId("server", {
    keepers: {
        azi_id: 1,
    },
    byteLength: 8,
});
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const examplePlan = new azure.appservice.Plan("examplePlan", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: {
        tier: "Standard",
        size: "S1",
    },
});
const exampleAppService = new azure.appservice.AppService("exampleAppService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    appServicePlanId: examplePlan.id,
});
const exampleCustomHostnameBinding = new azure.appservice.CustomHostnameBinding("exampleCustomHostnameBinding", {
    hostname: "www.mywebsite.com",
    appServiceName: exampleAppService.name,
    resourceGroupName: exampleResourceGroup.name,
});

Create a CustomHostnameBinding Resource

new CustomHostnameBinding(name: string, args: CustomHostnameBindingArgs, opts?: CustomResourceOptions);

def CustomHostnameBinding(resource_name, opts=None, app_service_name=None, hostname=None, resource_group_name=None, ssl_state=None, thumbprint=None, __props__=None);

func NewCustomHostnameBinding(ctx *Context, name string, args CustomHostnameBindingArgs, opts ...ResourceOption) (*CustomHostnameBinding, error)

public CustomHostnameBinding(string name, CustomHostnameBindingArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args CustomHostnameBindingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args CustomHostnameBindingArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CustomHostnameBindingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

CustomHostnameBinding Resource Properties

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

Inputs

The CustomHostnameBinding resource accepts the following input properties:

AppServiceName string: The name of the App Service in which to add the Custom Hostname Binding. Changing this forces a new resource to be created.
Hostname string: Specifies the Custom Hostname to use for the App Service, example www.example.com. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
SslState string: The SSL type. Possible values are IpBasedEnabled and SniEnabled. Changing this forces a new resource to be created.
Thumbprint string: The SSL certificate thumbprint. Changing this forces a new resource to be created.

AppServiceName string: The name of the App Service in which to add the Custom Hostname Binding. Changing this forces a new resource to be created.
Hostname string: Specifies the Custom Hostname to use for the App Service, example www.example.com. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
SslState string: The SSL type. Possible values are IpBasedEnabled and SniEnabled. Changing this forces a new resource to be created.
Thumbprint string: The SSL certificate thumbprint. Changing this forces a new resource to be created.

appServiceName string: The name of the App Service in which to add the Custom Hostname Binding. Changing this forces a new resource to be created.
hostname string: Specifies the Custom Hostname to use for the App Service, example www.example.com. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
sslState string: The SSL type. Possible values are IpBasedEnabled and SniEnabled. Changing this forces a new resource to be created.
thumbprint string: The SSL certificate thumbprint. Changing this forces a new resource to be created.

app_service_name str: The name of the App Service in which to add the Custom Hostname Binding. Changing this forces a new resource to be created.
hostname str: Specifies the Custom Hostname to use for the App Service, example www.example.com. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
ssl_state str: The SSL type. Possible values are IpBasedEnabled and SniEnabled. Changing this forces a new resource to be created.
thumbprint str: The SSL certificate thumbprint. Changing this forces a new resource to be created.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
VirtualIp string: The virtual IP address assigned to the hostname if IP based SSL is enabled.

Id string: The provider-assigned unique ID for this managed resource.
VirtualIp string: The virtual IP address assigned to the hostname if IP based SSL is enabled.

id string: The provider-assigned unique ID for this managed resource.
virtualIp string: The virtual IP address assigned to the hostname if IP based SSL is enabled.

id str: The provider-assigned unique ID for this managed resource.
virtual_ip str: The virtual IP address assigned to the hostname if IP based SSL is enabled.

Look up an Existing CustomHostnameBinding Resource

Get an existing CustomHostnameBinding 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?: CustomHostnameBindingState, opts?: CustomResourceOptions): CustomHostnameBinding

static get(resource_name, id, opts=None, app_service_name=None, hostname=None, resource_group_name=None, ssl_state=None, thumbprint=None, virtual_ip=None, __props__=None);

func GetCustomHostnameBinding(ctx *Context, name string, id IDInput, state *CustomHostnameBindingState, opts ...ResourceOption) (*CustomHostnameBinding, error)

public static CustomHostnameBinding Get(string name, Input<string> id, CustomHostnameBindingState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

AppServiceName string: The name of the App Service in which to add the Custom Hostname Binding. Changing this forces a new resource to be created.
Hostname string: Specifies the Custom Hostname to use for the App Service, example www.example.com. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
SslState string: The SSL type. Possible values are IpBasedEnabled and SniEnabled. Changing this forces a new resource to be created.
Thumbprint string: The SSL certificate thumbprint. Changing this forces a new resource to be created.
VirtualIp string: The virtual IP address assigned to the hostname if IP based SSL is enabled.

AppServiceName string: The name of the App Service in which to add the Custom Hostname Binding. Changing this forces a new resource to be created.
Hostname string: Specifies the Custom Hostname to use for the App Service, example www.example.com. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
SslState string: The SSL type. Possible values are IpBasedEnabled and SniEnabled. Changing this forces a new resource to be created.
Thumbprint string: The SSL certificate thumbprint. Changing this forces a new resource to be created.
VirtualIp string: The virtual IP address assigned to the hostname if IP based SSL is enabled.

appServiceName string: The name of the App Service in which to add the Custom Hostname Binding. Changing this forces a new resource to be created.
hostname string: Specifies the Custom Hostname to use for the App Service, example www.example.com. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
sslState string: The SSL type. Possible values are IpBasedEnabled and SniEnabled. Changing this forces a new resource to be created.
thumbprint string: The SSL certificate thumbprint. Changing this forces a new resource to be created.
virtualIp string: The virtual IP address assigned to the hostname if IP based SSL is enabled.

app_service_name str: The name of the App Service in which to add the Custom Hostname Binding. Changing this forces a new resource to be created.
hostname str: Specifies the Custom Hostname to use for the App Service, example www.example.com. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
ssl_state str: The SSL type. Possible values are IpBasedEnabled and SniEnabled. Changing this forces a new resource to be created.
thumbprint str: The SSL certificate thumbprint. Changing this forces a new resource to be created.
virtual_ip str: The virtual IP address assigned to the hostname if IP based SSL is enabled.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud