Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. WebAppHostNameBinding
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.web.WebAppHostNameBinding

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    A hostname binding object. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2020-12-01.

    Other available API versions: 2020-10-01, 2023-01-01, 2023-12-01, 2024-04-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}

    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 string
    The unique name of the resource.
    args WebAppHostNameBindingArgs
    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 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 string
    The unique name of the resource.
    args WebAppHostNameBindingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebAppHostNameBindingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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 = AzureNative.Web.AzureResourceType.Website,
    CustomHostNameDnsRecordType = AzureNative.Web.CustomHostNameDnsRecordType.CName,
    DomainId = "string",
    HostName = "string",
    HostNameType = AzureNative.Web.HostNameType.Verified,
    Kind = "string",
    SiteName = "string",
    SslState = AzureNative.Web.SslState.Disabled,
    Thumbprint = "string",
});

    example, err := web.NewWebAppHostNameBinding(ctx, "webAppHostNameBindingResource", &web.WebAppHostNameBindingArgs{
	Name:                        pulumi.String("string"),
	ResourceGroupName:           pulumi.String("string"),
	AzureResourceName:           pulumi.String("string"),
	AzureResourceType:           web.AzureResourceTypeWebsite,
	CustomHostNameDnsRecordType: web.CustomHostNameDnsRecordTypeCName,
	DomainId:                    pulumi.String("string"),
	HostName:                    pulumi.String("string"),
	HostNameType:                web.HostNameTypeVerified,
	Kind:                        pulumi.String("string"),
	SiteName:                    pulumi.String("string"),
	SslState:                    web.SslStateDisabled,
	Thumbprint:                  pulumi.String("string"),
})

    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());

    web_app_host_name_binding_resource = azure_native.web.WebAppHostNameBinding("webAppHostNameBindingResource",
    name="string",
    resource_group_name="string",
    azure_resource_name="string",
    azure_resource_type=azure_native.web.AzureResourceType.WEBSITE,
    custom_host_name_dns_record_type=azure_native.web.CustomHostNameDnsRecordType.C_NAME,
    domain_id="string",
    host_name="string",
    host_name_type=azure_native.web.HostNameType.VERIFIED,
    kind="string",
    site_name="string",
    ssl_state=azure_native.web.SslState.DISABLED,
    thumbprint="string")

    const webAppHostNameBindingResource = new azure_native.web.WebAppHostNameBinding("webAppHostNameBindingResource", {
    name: "string",
    resourceGroupName: "string",
    azureResourceName: "string",
    azureResourceType: azure_native.web.AzureResourceType.Website,
    customHostNameDnsRecordType: azure_native.web.CustomHostNameDnsRecordType.CName,
    domainId: "string",
    hostName: "string",
    hostNameType: azure_native.web.HostNameType.Verified,
    kind: "string",
    siteName: "string",
    sslState: azure_native.web.SslState.Disabled,
    thumbprint: "string",
});

    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

    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 string
    Name of the app.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    AzureResourceName string
    Azure resource name.
    AzureResourceType Pulumi.AzureNative.Web.AzureResourceType
    Azure resource type.
    CustomHostNameDnsRecordType Pulumi.AzureNative.Web.CustomHostNameDnsRecordType
    Custom DNS record type.
    DomainId string
    Fully qualified ARM domain resource URI.
    HostName string
    Hostname in the hostname binding.
    HostNameType Pulumi.AzureNative.Web.HostNameType
    Hostname type.
    Kind string
    Kind of resource.
    SiteName string
    App Service app name.
    SslState Pulumi.AzureNative.Web.SslState
    SSL type
    Thumbprint string
    SSL certificate thumbprint
    Name string
    Name of the app.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    AzureResourceName string
    Azure resource name.
    AzureResourceType AzureResourceType
    Azure resource type.
    CustomHostNameDnsRecordType CustomHostNameDnsRecordType
    Custom DNS record type.
    DomainId string
    Fully qualified ARM domain resource URI.
    HostName string
    Hostname in the hostname binding.
    HostNameType HostNameType
    Hostname type.
    Kind string
    Kind of resource.
    SiteName string
    App Service app name.
    SslState SslState
    SSL type
    Thumbprint string
    SSL certificate thumbprint
    name String
    Name of the app.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    azureResourceName String
    Azure resource name.
    azureResourceType AzureResourceType
    Azure resource type.
    customHostNameDnsRecordType CustomHostNameDnsRecordType
    Custom DNS record type.
    domainId String
    Fully qualified ARM domain resource URI.
    hostName String
    Hostname in the hostname binding.
    hostNameType HostNameType
    Hostname type.
    kind String
    Kind of resource.
    siteName String
    App Service app name.
    sslState SslState
    SSL type
    thumbprint String
    SSL certificate thumbprint
    name string
    Name of the app.
    resourceGroupName string
    Name of the resource group to which the resource belongs.
    azureResourceName string
    Azure resource name.
    azureResourceType AzureResourceType
    Azure resource type.
    customHostNameDnsRecordType CustomHostNameDnsRecordType
    Custom DNS record type.
    domainId string
    Fully qualified ARM domain resource URI.
    hostName string
    Hostname in the hostname binding.
    hostNameType HostNameType
    Hostname type.
    kind string
    Kind of resource.
    siteName string
    App Service app name.
    sslState SslState
    SSL type
    thumbprint string
    SSL certificate thumbprint
    name str
    Name of the app.
    resource_group_name str
    Name of the resource group to which the resource belongs.
    azure_resource_name str
    Azure resource name.
    azure_resource_type AzureResourceType
    Azure resource type.
    custom_host_name_dns_record_type CustomHostNameDnsRecordType
    Custom DNS record type.
    domain_id str
    Fully qualified ARM domain resource URI.
    host_name str
    Hostname in the hostname binding.
    host_name_type HostNameType
    Hostname type.
    kind str
    Kind of resource.
    site_name str
    App Service app name.
    ssl_state SslState
    SSL type
    thumbprint str
    SSL certificate thumbprint
    name String
    Name of the app.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    azureResourceName String
    Azure resource name.
    azureResourceType "Website" | "TrafficManager"
    Azure resource type.
    customHostNameDnsRecordType "CName" | "A"
    Custom DNS record type.
    domainId String
    Fully qualified ARM domain resource URI.
    hostName String
    Hostname in the hostname binding.
    hostNameType "Verified" | "Managed"
    Hostname type.
    kind String
    Kind of resource.
    siteName String
    App Service app name.
    sslState "Disabled" | "SniEnabled" | "IpBasedEnabled"
    SSL type
    thumbprint 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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native