Azure Classic v5.38.0, Mar 21 23

azure.appservice.CustomHostnameBinding

Manages a Hostname Binding within an App Service (or Function App).

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;
using Random = Pulumi.Random;

return await Deployment.RunAsync(() => 
{
    var server = new Random.RandomId("server", new()
    {
        Keepers = 
        {
            { "azi_id", 1 },
        },
        ByteLength = 8,
    });

    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var examplePlan = new Azure.AppService.Plan("examplePlan", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        Sku = new Azure.AppService.Inputs.PlanSkuArgs
        {
            Tier = "Standard",
            Size = "S1",
        },
    });

    var exampleAppService = new Azure.AppService.AppService("exampleAppService", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        AppServicePlanId = examplePlan.Id,
    });

    var exampleCustomHostnameBinding = new Azure.AppService.CustomHostnameBinding("exampleCustomHostnameBinding", new()
    {
        Hostname = "www.mywebsite.com",
        AppServiceName = exampleAppService.Name,
        ResourceGroupName = exampleResourceGroup.Name,
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/appservice"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := random.NewRandomId(ctx, "server", &random.RandomIdArgs{
			Keepers: pulumi.AnyMap{
				"azi_id": pulumi.Any(1),
			},
			ByteLength: pulumi.Int(8),
		})
		if err != nil {
			return err
		}
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		examplePlan, err := appservice.NewPlan(ctx, "examplePlan", &appservice.PlanArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			Sku: &appservice.PlanSkuArgs{
				Tier: pulumi.String("Standard"),
				Size: pulumi.String("S1"),
			},
		})
		if err != nil {
			return err
		}
		exampleAppService, err := appservice.NewAppService(ctx, "exampleAppService", &appservice.AppServiceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			AppServicePlanId:  examplePlan.ID(),
		})
		if err != nil {
			return err
		}
		_, err = appservice.NewCustomHostnameBinding(ctx, "exampleCustomHostnameBinding", &appservice.CustomHostnameBindingArgs{
			Hostname:          pulumi.String("www.mywebsite.com"),
			AppServiceName:    exampleAppService.Name,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		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.random.RandomId;
import com.pulumi.random.RandomIdArgs;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.appservice.Plan;
import com.pulumi.azure.appservice.PlanArgs;
import com.pulumi.azure.appservice.inputs.PlanSkuArgs;
import com.pulumi.azure.appservice.AppService;
import com.pulumi.azure.appservice.AppServiceArgs;
import com.pulumi.azure.appservice.CustomHostnameBinding;
import com.pulumi.azure.appservice.CustomHostnameBindingArgs;
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 server = new RandomId("server", RandomIdArgs.builder()        
            .keepers(Map.of("azi_id", 1))
            .byteLength(8)
            .build());

        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var examplePlan = new Plan("examplePlan", PlanArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .sku(PlanSkuArgs.builder()
                .tier("Standard")
                .size("S1")
                .build())
            .build());

        var exampleAppService = new AppService("exampleAppService", AppServiceArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .appServicePlanId(examplePlan.id())
            .build());

        var exampleCustomHostnameBinding = new CustomHostnameBinding("exampleCustomHostnameBinding", CustomHostnameBindingArgs.builder()        
            .hostname("www.mywebsite.com")
            .appServiceName(exampleAppService.name())
            .resourceGroupName(exampleResourceGroup.name())
            .build());

    }
}

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=azure.appservice.PlanSkuArgs(
        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,
});

resources:
  server:
    type: random:RandomId
    properties:
      keepers:
        azi_id: 1
      byteLength: 8
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  examplePlan:
    type: azure:appservice:Plan
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      sku:
        tier: Standard
        size: S1
  exampleAppService:
    type: azure:appservice:AppService
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      appServicePlanId: ${examplePlan.id}
  exampleCustomHostnameBinding:
    type: azure:appservice:CustomHostnameBinding
    properties:
      hostname: www.mywebsite.com
      appServiceName: ${exampleAppService.name}
      resourceGroupName: ${exampleResourceGroup.name}

Create CustomHostnameBinding Resource

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

@overload
def CustomHostnameBinding(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          app_service_name: Optional[str] = None,
                          hostname: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          ssl_state: Optional[str] = None,
                          thumbprint: Optional[str] = None)
@overload
def CustomHostnameBinding(resource_name: str,
                          args: CustomHostnameBindingArgs,
                          opts: Optional[ResourceOptions] = None)

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

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

public CustomHostnameBinding(String name, CustomHostnameBindingArgs args)
public CustomHostnameBinding(String name, CustomHostnameBindingArgs args, CustomResourceOptions options)

type: azure:appservice:CustomHostnameBinding
properties: # The arguments to resource properties.
options: # 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.

resource_name str: The unique name of the resource.
args CustomHostnameBindingArgs: 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 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.

name String: The unique name of the resource.
args CustomHostnameBindingArgs: The arguments to resource properties.
options 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 Architecture and Concepts 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.

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.

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.

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

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.

Look up 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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_service_name: Optional[str] = None,
        hostname: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        ssl_state: Optional[str] = None,
        thumbprint: Optional[str] = None,
        virtual_ip: Optional[str] = None) -> CustomHostnameBinding

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)

public static CustomHostnameBinding get(String name, Output<String> id, CustomHostnameBindingState 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.

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.

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.

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.

Import

App Service Custom Hostname Bindings can be imported using the resource id, e.g.

 $ pulumi import azure:appservice/customHostnameBinding:CustomHostnameBinding mywebsite /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Web/sites/instance1/hostNameBindings/mywebsite.com

Package Details

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