We recommend using Azure Native.
azure.appservice.CustomHostnameBinding
Explore with Pulumi AI
Manages a Hostname Binding within an App Service (or Function App).
Example Usage
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 example = new azure.core.ResourceGroup("example", {
name: "some-resource-group",
location: "West Europe",
});
const examplePlan = new azure.appservice.Plan("example", {
name: "some-app-service-plan",
location: example.location,
resourceGroupName: example.name,
sku: {
tier: "Standard",
size: "S1",
},
});
const exampleAppService = new azure.appservice.AppService("example", {
name: server.hex,
location: example.location,
resourceGroupName: example.name,
appServicePlanId: examplePlan.id,
});
const exampleCustomHostnameBinding = new azure.appservice.CustomHostnameBinding("example", {
hostname: "www.mywebsite.com",
appServiceName: exampleAppService.name,
resourceGroupName: example.name,
});
import pulumi
import pulumi_azure as azure
import pulumi_random as random
server = random.RandomId("server",
keepers={
"azi_id": "1",
},
byte_length=8)
example = azure.core.ResourceGroup("example",
name="some-resource-group",
location="West Europe")
example_plan = azure.appservice.Plan("example",
name="some-app-service-plan",
location=example.location,
resource_group_name=example.name,
sku={
"tier": "Standard",
"size": "S1",
})
example_app_service = azure.appservice.AppService("example",
name=server.hex,
location=example.location,
resource_group_name=example.name,
app_service_plan_id=example_plan.id)
example_custom_hostname_binding = azure.appservice.CustomHostnameBinding("example",
hostname="www.mywebsite.com",
app_service_name=example_app_service.name,
resource_group_name=example.name)
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appservice"
"github.com/pulumi/pulumi-azure/sdk/v6/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 {
server, err := random.NewRandomId(ctx, "server", &random.RandomIdArgs{
Keepers: pulumi.StringMap{
"azi_id": pulumi.String("1"),
},
ByteLength: pulumi.Int(8),
})
if err != nil {
return err
}
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("some-resource-group"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
examplePlan, err := appservice.NewPlan(ctx, "example", &appservice.PlanArgs{
Name: pulumi.String("some-app-service-plan"),
Location: example.Location,
ResourceGroupName: example.Name,
Sku: &appservice.PlanSkuArgs{
Tier: pulumi.String("Standard"),
Size: pulumi.String("S1"),
},
})
if err != nil {
return err
}
exampleAppService, err := appservice.NewAppService(ctx, "example", &appservice.AppServiceArgs{
Name: server.Hex,
Location: example.Location,
ResourceGroupName: example.Name,
AppServicePlanId: examplePlan.ID(),
})
if err != nil {
return err
}
_, err = appservice.NewCustomHostnameBinding(ctx, "example", &appservice.CustomHostnameBindingArgs{
Hostname: pulumi.String("www.mywebsite.com"),
AppServiceName: exampleAppService.Name,
ResourceGroupName: example.Name,
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
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 example = new Azure.Core.ResourceGroup("example", new()
{
Name = "some-resource-group",
Location = "West Europe",
});
var examplePlan = new Azure.AppService.Plan("example", new()
{
Name = "some-app-service-plan",
Location = example.Location,
ResourceGroupName = example.Name,
Sku = new Azure.AppService.Inputs.PlanSkuArgs
{
Tier = "Standard",
Size = "S1",
},
});
var exampleAppService = new Azure.AppService.AppService("example", new()
{
Name = server.Hex,
Location = example.Location,
ResourceGroupName = example.Name,
AppServicePlanId = examplePlan.Id,
});
var exampleCustomHostnameBinding = new Azure.AppService.CustomHostnameBinding("example", new()
{
Hostname = "www.mywebsite.com",
AppServiceName = exampleAppService.Name,
ResourceGroupName = example.Name,
});
});
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("some-resource-group")
.location("West Europe")
.build());
var examplePlan = new Plan("examplePlan", PlanArgs.builder()
.name("some-app-service-plan")
.location(example.location())
.resourceGroupName(example.name())
.sku(PlanSkuArgs.builder()
.tier("Standard")
.size("S1")
.build())
.build());
var exampleAppService = new AppService("exampleAppService", AppServiceArgs.builder()
.name(server.hex())
.location(example.location())
.resourceGroupName(example.name())
.appServicePlanId(examplePlan.id())
.build());
var exampleCustomHostnameBinding = new CustomHostnameBinding("exampleCustomHostnameBinding", CustomHostnameBindingArgs.builder()
.hostname("www.mywebsite.com")
.appServiceName(exampleAppService.name())
.resourceGroupName(example.name())
.build());
}
}
resources:
server:
type: random:RandomId
properties:
keepers:
azi_id: 1
byteLength: 8
example:
type: azure:core:ResourceGroup
properties:
name: some-resource-group
location: West Europe
examplePlan:
type: azure:appservice:Plan
name: example
properties:
name: some-app-service-plan
location: ${example.location}
resourceGroupName: ${example.name}
sku:
tier: Standard
size: S1
exampleAppService:
type: azure:appservice:AppService
name: example
properties:
name: ${server.hex}
location: ${example.location}
resourceGroupName: ${example.name}
appServicePlanId: ${examplePlan.id}
exampleCustomHostnameBinding:
type: azure:appservice:CustomHostnameBinding
name: example
properties:
hostname: www.mywebsite.com
appServiceName: ${exampleAppService.name}
resourceGroupName: ${example.name}
Create CustomHostnameBinding Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CustomHostnameBinding(name: string, args: CustomHostnameBindingArgs, opts?: CustomResourceOptions);
@overload
def CustomHostnameBinding(resource_name: str,
args: CustomHostnameBindingArgs,
opts: Optional[ResourceOptions] = None)
@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)
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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var customHostnameBindingResource = new Azure.AppService.CustomHostnameBinding("customHostnameBindingResource", new()
{
AppServiceName = "string",
Hostname = "string",
ResourceGroupName = "string",
SslState = "string",
Thumbprint = "string",
});
example, err := appservice.NewCustomHostnameBinding(ctx, "customHostnameBindingResource", &appservice.CustomHostnameBindingArgs{
AppServiceName: pulumi.String("string"),
Hostname: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
SslState: pulumi.String("string"),
Thumbprint: pulumi.String("string"),
})
var customHostnameBindingResource = new CustomHostnameBinding("customHostnameBindingResource", CustomHostnameBindingArgs.builder()
.appServiceName("string")
.hostname("string")
.resourceGroupName("string")
.sslState("string")
.thumbprint("string")
.build());
custom_hostname_binding_resource = azure.appservice.CustomHostnameBinding("customHostnameBindingResource",
app_service_name="string",
hostname="string",
resource_group_name="string",
ssl_state="string",
thumbprint="string")
const customHostnameBindingResource = new azure.appservice.CustomHostnameBinding("customHostnameBindingResource", {
appServiceName: "string",
hostname: "string",
resourceGroupName: "string",
sslState: "string",
thumbprint: "string",
});
type: azure:appservice:CustomHostnameBinding
properties:
appServiceName: string
hostname: string
resourceGroupName: string
sslState: string
thumbprint: string
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:
- App
Service stringName - 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.NOTE: A CNAME needs to be configured from this Hostname to the Azure Website - otherwise Azure will reject the Hostname Binding.
- Resource
Group stringName - The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
- Ssl
State string - The SSL type. Possible values are
IpBasedEnabled
andSniEnabled
. Changing this forces a new resource to be created. - Thumbprint string
The SSL certificate thumbprint. Changing this forces a new resource to be created.
NOTE:
thumbprint
must be specified whenssl_state
is set.
- App
Service stringName - 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.NOTE: A CNAME needs to be configured from this Hostname to the Azure Website - otherwise Azure will reject the Hostname Binding.
- Resource
Group stringName - The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
- Ssl
State string - The SSL type. Possible values are
IpBasedEnabled
andSniEnabled
. Changing this forces a new resource to be created. - Thumbprint string
The SSL certificate thumbprint. Changing this forces a new resource to be created.
NOTE:
thumbprint
must be specified whenssl_state
is set.
- app
Service StringName - 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.NOTE: A CNAME needs to be configured from this Hostname to the Azure Website - otherwise Azure will reject the Hostname Binding.
- resource
Group StringName - The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
- ssl
State String - The SSL type. Possible values are
IpBasedEnabled
andSniEnabled
. Changing this forces a new resource to be created. - thumbprint String
The SSL certificate thumbprint. Changing this forces a new resource to be created.
NOTE:
thumbprint
must be specified whenssl_state
is set.
- app
Service stringName - 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.NOTE: A CNAME needs to be configured from this Hostname to the Azure Website - otherwise Azure will reject the Hostname Binding.
- resource
Group stringName - The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
- ssl
State string - The SSL type. Possible values are
IpBasedEnabled
andSniEnabled
. Changing this forces a new resource to be created. - thumbprint string
The SSL certificate thumbprint. Changing this forces a new resource to be created.
NOTE:
thumbprint
must be specified whenssl_state
is set.
- app_
service_ strname - 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.NOTE: A CNAME needs to be configured from this Hostname to the Azure Website - otherwise Azure will reject the Hostname Binding.
- resource_
group_ strname - 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
andSniEnabled
. Changing this forces a new resource to be created. - thumbprint str
The SSL certificate thumbprint. Changing this forces a new resource to be created.
NOTE:
thumbprint
must be specified whenssl_state
is set.
- app
Service StringName - 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.NOTE: A CNAME needs to be configured from this Hostname to the Azure Website - otherwise Azure will reject the Hostname Binding.
- resource
Group StringName - The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
- ssl
State String - The SSL type. Possible values are
IpBasedEnabled
andSniEnabled
. Changing this forces a new resource to be created. - thumbprint String
The SSL certificate thumbprint. Changing this forces a new resource to be created.
NOTE:
thumbprint
must be specified whenssl_state
is set.
Outputs
All input properties are implicitly available as output properties. Additionally, the CustomHostnameBinding resource produces the following output properties:
- 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 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.
- App
Service stringName - 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.NOTE: A CNAME needs to be configured from this Hostname to the Azure Website - otherwise Azure will reject the Hostname Binding.
- Resource
Group stringName - The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
- Ssl
State string - The SSL type. Possible values are
IpBasedEnabled
andSniEnabled
. Changing this forces a new resource to be created. - Thumbprint string
The SSL certificate thumbprint. Changing this forces a new resource to be created.
NOTE:
thumbprint
must be specified whenssl_state
is set.- Virtual
Ip string - The virtual IP address assigned to the hostname if IP based SSL is enabled.
- App
Service stringName - 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.NOTE: A CNAME needs to be configured from this Hostname to the Azure Website - otherwise Azure will reject the Hostname Binding.
- Resource
Group stringName - The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
- Ssl
State string - The SSL type. Possible values are
IpBasedEnabled
andSniEnabled
. Changing this forces a new resource to be created. - Thumbprint string
The SSL certificate thumbprint. Changing this forces a new resource to be created.
NOTE:
thumbprint
must be specified whenssl_state
is set.- Virtual
Ip string - The virtual IP address assigned to the hostname if IP based SSL is enabled.
- app
Service StringName - 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.NOTE: A CNAME needs to be configured from this Hostname to the Azure Website - otherwise Azure will reject the Hostname Binding.
- resource
Group StringName - The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
- ssl
State String - The SSL type. Possible values are
IpBasedEnabled
andSniEnabled
. Changing this forces a new resource to be created. - thumbprint String
The SSL certificate thumbprint. Changing this forces a new resource to be created.
NOTE:
thumbprint
must be specified whenssl_state
is set.- virtual
Ip String - The virtual IP address assigned to the hostname if IP based SSL is enabled.
- app
Service stringName - 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.NOTE: A CNAME needs to be configured from this Hostname to the Azure Website - otherwise Azure will reject the Hostname Binding.
- resource
Group stringName - The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
- ssl
State string - The SSL type. Possible values are
IpBasedEnabled
andSniEnabled
. Changing this forces a new resource to be created. - thumbprint string
The SSL certificate thumbprint. Changing this forces a new resource to be created.
NOTE:
thumbprint
must be specified whenssl_state
is set.- virtual
Ip string - The virtual IP address assigned to the hostname if IP based SSL is enabled.
- app_
service_ strname - 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.NOTE: A CNAME needs to be configured from this Hostname to the Azure Website - otherwise Azure will reject the Hostname Binding.
- resource_
group_ strname - 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
andSniEnabled
. Changing this forces a new resource to be created. - thumbprint str
The SSL certificate thumbprint. Changing this forces a new resource to be created.
NOTE:
thumbprint
must be specified whenssl_state
is set.- virtual_
ip str - The virtual IP address assigned to the hostname if IP based SSL is enabled.
- app
Service StringName - 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.NOTE: A CNAME needs to be configured from this Hostname to the Azure Website - otherwise Azure will reject the Hostname Binding.
- resource
Group StringName - The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.
- ssl
State String - The SSL type. Possible values are
IpBasedEnabled
andSniEnabled
. Changing this forces a new resource to be created. - thumbprint String
The SSL certificate thumbprint. Changing this forces a new resource to be created.
NOTE:
thumbprint
must be specified whenssl_state
is set.- virtual
Ip 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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.