Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. web
  5. WebAppHostNameBinding
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.web.WebAppHostNameBinding

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

A hostname binding object. API Version: 2020-12-01.

Import

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

$ pulumi import azure-native:web:WebAppHostNameBinding myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
Copy

Create WebAppHostNameBinding Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new WebAppHostNameBinding(name: string, args: WebAppHostNameBindingArgs, opts?: CustomResourceOptions);
@overload
def WebAppHostNameBinding(resource_name: str,
                          args: WebAppHostNameBindingArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def WebAppHostNameBinding(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          azure_resource_name: Optional[str] = None,
                          azure_resource_type: Optional[AzureResourceType] = None,
                          custom_host_name_dns_record_type: Optional[CustomHostNameDnsRecordType] = None,
                          domain_id: Optional[str] = None,
                          host_name: Optional[str] = None,
                          host_name_type: Optional[HostNameType] = None,
                          kind: Optional[str] = None,
                          site_name: Optional[str] = None,
                          ssl_state: Optional[SslState] = None,
                          thumbprint: Optional[str] = None)
func NewWebAppHostNameBinding(ctx *Context, name string, args WebAppHostNameBindingArgs, opts ...ResourceOption) (*WebAppHostNameBinding, error)
public WebAppHostNameBinding(string name, WebAppHostNameBindingArgs args, CustomResourceOptions? opts = null)
public WebAppHostNameBinding(String name, WebAppHostNameBindingArgs args)
public WebAppHostNameBinding(String name, WebAppHostNameBindingArgs args, CustomResourceOptions options)

type: azure-native:web:WebAppHostNameBinding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WebAppHostNameBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WebAppHostNameBindingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WebAppHostNameBindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WebAppHostNameBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WebAppHostNameBindingArgs
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 webAppHostNameBindingResource = new AzureNative.Web.WebAppHostNameBinding("webAppHostNameBindingResource", new()
{
    Name = "string",
    ResourceGroupName = "string",
    AzureResourceName = "string",
    AzureResourceType = "Website",
    CustomHostNameDnsRecordType = "CName",
    DomainId = "string",
    HostName = "string",
    HostNameType = "Verified",
    Kind = "string",
    SiteName = "string",
    SslState = "Disabled",
    Thumbprint = "string",
});
Copy
example, err := web.NewWebAppHostNameBinding(ctx, "webAppHostNameBindingResource", &web.WebAppHostNameBindingArgs{
	Name:                        "string",
	ResourceGroupName:           "string",
	AzureResourceName:           "string",
	AzureResourceType:           "Website",
	CustomHostNameDnsRecordType: "CName",
	DomainId:                    "string",
	HostName:                    "string",
	HostNameType:                "Verified",
	Kind:                        "string",
	SiteName:                    "string",
	SslState:                    "Disabled",
	Thumbprint:                  "string",
})
Copy
var webAppHostNameBindingResource = new WebAppHostNameBinding("webAppHostNameBindingResource", WebAppHostNameBindingArgs.builder()
    .name("string")
    .resourceGroupName("string")
    .azureResourceName("string")
    .azureResourceType("Website")
    .customHostNameDnsRecordType("CName")
    .domainId("string")
    .hostName("string")
    .hostNameType("Verified")
    .kind("string")
    .siteName("string")
    .sslState("Disabled")
    .thumbprint("string")
    .build());
Copy
web_app_host_name_binding_resource = azure_native.web.WebAppHostNameBinding("webAppHostNameBindingResource",
    name=string,
    resource_group_name=string,
    azure_resource_name=string,
    azure_resource_type=Website,
    custom_host_name_dns_record_type=CName,
    domain_id=string,
    host_name=string,
    host_name_type=Verified,
    kind=string,
    site_name=string,
    ssl_state=Disabled,
    thumbprint=string)
Copy
const webAppHostNameBindingResource = new azure_native.web.WebAppHostNameBinding("webAppHostNameBindingResource", {
    name: "string",
    resourceGroupName: "string",
    azureResourceName: "string",
    azureResourceType: "Website",
    customHostNameDnsRecordType: "CName",
    domainId: "string",
    hostName: "string",
    hostNameType: "Verified",
    kind: "string",
    siteName: "string",
    sslState: "Disabled",
    thumbprint: "string",
});
Copy
type: azure-native:web:WebAppHostNameBinding
properties:
    azureResourceName: string
    azureResourceType: Website
    customHostNameDnsRecordType: CName
    domainId: string
    hostName: string
    hostNameType: Verified
    kind: string
    name: string
    resourceGroupName: string
    siteName: string
    sslState: Disabled
    thumbprint: string
Copy

WebAppHostNameBinding Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The WebAppHostNameBinding resource accepts the following input properties:

Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the app.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
AzureResourceName Changes to this property will trigger replacement. string
Azure resource name.
AzureResourceType Changes to this property will trigger replacement. Pulumi.AzureNative.Web.AzureResourceType
Azure resource type.
CustomHostNameDnsRecordType Changes to this property will trigger replacement. Pulumi.AzureNative.Web.CustomHostNameDnsRecordType
Custom DNS record type.
DomainId Changes to this property will trigger replacement. string
Fully qualified ARM domain resource URI.
HostName Changes to this property will trigger replacement. string
Hostname in the hostname binding.
HostNameType Changes to this property will trigger replacement. Pulumi.AzureNative.Web.HostNameType
Hostname type.
Kind string
Kind of resource.
SiteName Changes to this property will trigger replacement. string
App Service app name.
SslState Changes to this property will trigger replacement. Pulumi.AzureNative.Web.SslState
SSL type
Thumbprint Changes to this property will trigger replacement. string
SSL certificate thumbprint
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the app.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
AzureResourceName Changes to this property will trigger replacement. string
Azure resource name.
AzureResourceType Changes to this property will trigger replacement. AzureResourceType
Azure resource type.
CustomHostNameDnsRecordType Changes to this property will trigger replacement. CustomHostNameDnsRecordType
Custom DNS record type.
DomainId Changes to this property will trigger replacement. string
Fully qualified ARM domain resource URI.
HostName Changes to this property will trigger replacement. string
Hostname in the hostname binding.
HostNameType Changes to this property will trigger replacement. HostNameType
Hostname type.
Kind string
Kind of resource.
SiteName Changes to this property will trigger replacement. string
App Service app name.
SslState Changes to this property will trigger replacement. SslState
SSL type
Thumbprint Changes to this property will trigger replacement. string
SSL certificate thumbprint
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
azureResourceName Changes to this property will trigger replacement. String
Azure resource name.
azureResourceType Changes to this property will trigger replacement. AzureResourceType
Azure resource type.
customHostNameDnsRecordType Changes to this property will trigger replacement. CustomHostNameDnsRecordType
Custom DNS record type.
domainId Changes to this property will trigger replacement. String
Fully qualified ARM domain resource URI.
hostName Changes to this property will trigger replacement. String
Hostname in the hostname binding.
hostNameType Changes to this property will trigger replacement. HostNameType
Hostname type.
kind String
Kind of resource.
siteName Changes to this property will trigger replacement. String
App Service app name.
sslState Changes to this property will trigger replacement. SslState
SSL type
thumbprint Changes to this property will trigger replacement. String
SSL certificate thumbprint
name
This property is required.
Changes to this property will trigger replacement.
string
Name of the app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
azureResourceName Changes to this property will trigger replacement. string
Azure resource name.
azureResourceType Changes to this property will trigger replacement. AzureResourceType
Azure resource type.
customHostNameDnsRecordType Changes to this property will trigger replacement. CustomHostNameDnsRecordType
Custom DNS record type.
domainId Changes to this property will trigger replacement. string
Fully qualified ARM domain resource URI.
hostName Changes to this property will trigger replacement. string
Hostname in the hostname binding.
hostNameType Changes to this property will trigger replacement. HostNameType
Hostname type.
kind string
Kind of resource.
siteName Changes to this property will trigger replacement. string
App Service app name.
sslState Changes to this property will trigger replacement. SslState
SSL type
thumbprint Changes to this property will trigger replacement. string
SSL certificate thumbprint
name
This property is required.
Changes to this property will trigger replacement.
str
Name of the app.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group to which the resource belongs.
azure_resource_name Changes to this property will trigger replacement. str
Azure resource name.
azure_resource_type Changes to this property will trigger replacement. AzureResourceType
Azure resource type.
custom_host_name_dns_record_type Changes to this property will trigger replacement. CustomHostNameDnsRecordType
Custom DNS record type.
domain_id Changes to this property will trigger replacement. str
Fully qualified ARM domain resource URI.
host_name Changes to this property will trigger replacement. str
Hostname in the hostname binding.
host_name_type Changes to this property will trigger replacement. HostNameType
Hostname type.
kind str
Kind of resource.
site_name Changes to this property will trigger replacement. str
App Service app name.
ssl_state Changes to this property will trigger replacement. SslState
SSL type
thumbprint Changes to this property will trigger replacement. str
SSL certificate thumbprint
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
azureResourceName Changes to this property will trigger replacement. String
Azure resource name.
azureResourceType Changes to this property will trigger replacement. "Website" | "TrafficManager"
Azure resource type.
customHostNameDnsRecordType Changes to this property will trigger replacement. "CName" | "A"
Custom DNS record type.
domainId Changes to this property will trigger replacement. String
Fully qualified ARM domain resource URI.
hostName Changes to this property will trigger replacement. String
Hostname in the hostname binding.
hostNameType Changes to this property will trigger replacement. "Verified" | "Managed"
Hostname type.
kind String
Kind of resource.
siteName Changes to this property will trigger replacement. String
App Service app name.
sslState Changes to this property will trigger replacement. "Disabled" | "SniEnabled" | "IpBasedEnabled"
SSL type
thumbprint Changes to this property will trigger replacement. String
SSL certificate thumbprint

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Type string
Resource type.
VirtualIP string
Virtual IP address assigned to the hostname if IP based SSL is enabled.
Id string
The provider-assigned unique ID for this managed resource.
Type string
Resource type.
VirtualIP string
Virtual IP address assigned to the hostname if IP based SSL is enabled.
id String
The provider-assigned unique ID for this managed resource.
type String
Resource type.
virtualIP String
Virtual IP address assigned to the hostname if IP based SSL is enabled.
id string
The provider-assigned unique ID for this managed resource.
type string
Resource type.
virtualIP string
Virtual IP address assigned to the hostname if IP based SSL is enabled.
id str
The provider-assigned unique ID for this managed resource.
type str
Resource type.
virtual_ip str
Virtual IP address assigned to the hostname if IP based SSL is enabled.
id String
The provider-assigned unique ID for this managed resource.
type String
Resource type.
virtualIP String
Virtual IP address assigned to the hostname if IP based SSL is enabled.

Supporting Types

AzureResourceType
, AzureResourceTypeArgs

Website
Website
TrafficManager
TrafficManager
AzureResourceTypeWebsite
Website
AzureResourceTypeTrafficManager
TrafficManager
Website
Website
TrafficManager
TrafficManager
Website
Website
TrafficManager
TrafficManager
WEBSITE
Website
TRAFFIC_MANAGER
TrafficManager
"Website"
Website
"TrafficManager"
TrafficManager

CustomHostNameDnsRecordType
, CustomHostNameDnsRecordTypeArgs

CName
CName
A
A
CustomHostNameDnsRecordTypeCName
CName
CustomHostNameDnsRecordTypeA
A
CName
CName
A
A
CName
CName
A
A
C_NAME
CName
A
A
"CName"
CName
"A"
A

HostNameType
, HostNameTypeArgs

Verified
Verified
Managed
Managed
HostNameTypeVerified
Verified
HostNameTypeManaged
Managed
Verified
Verified
Managed
Managed
Verified
Verified
Managed
Managed
VERIFIED
Verified
MANAGED
Managed
"Verified"
Verified
"Managed"
Managed

SslState
, SslStateArgs

Disabled
Disabled
SniEnabled
SniEnabled
IpBasedEnabled
IpBasedEnabled
SslStateDisabled
Disabled
SslStateSniEnabled
SniEnabled
SslStateIpBasedEnabled
IpBasedEnabled
Disabled
Disabled
SniEnabled
SniEnabled
IpBasedEnabled
IpBasedEnabled
Disabled
Disabled
SniEnabled
SniEnabled
IpBasedEnabled
IpBasedEnabled
DISABLED
Disabled
SNI_ENABLED
SniEnabled
IP_BASED_ENABLED
IpBasedEnabled
"Disabled"
Disabled
"SniEnabled"
SniEnabled
"IpBasedEnabled"
IpBasedEnabled

Package Details

Repository
azure-native-v1 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native