1. Packages
  2. Azure Classic
  3. API Docs
  4. cdn
  5. FrontdoorCustomDomain

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.cdn.FrontdoorCustomDomain

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-cdn-frontdoor",
        location: "West Europe",
    });
    const exampleZone = new azure.dns.Zone("example", {
        name: "sub-domain.domain.com",
        resourceGroupName: example.name,
    });
    const exampleFrontdoorProfile = new azure.cdn.FrontdoorProfile("example", {
        name: "example-profile",
        resourceGroupName: example.name,
        skuName: "Standard_AzureFrontDoor",
    });
    const exampleFrontdoorCustomDomain = new azure.cdn.FrontdoorCustomDomain("example", {
        name: "example-customDomain",
        cdnFrontdoorProfileId: exampleFrontdoorProfile.id,
        dnsZoneId: exampleZone.id,
        hostName: "contoso.fabrikam.com",
        tls: {
            certificateType: "ManagedCertificate",
            minimumTlsVersion: "TLS12",
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-cdn-frontdoor",
        location="West Europe")
    example_zone = azure.dns.Zone("example",
        name="sub-domain.domain.com",
        resource_group_name=example.name)
    example_frontdoor_profile = azure.cdn.FrontdoorProfile("example",
        name="example-profile",
        resource_group_name=example.name,
        sku_name="Standard_AzureFrontDoor")
    example_frontdoor_custom_domain = azure.cdn.FrontdoorCustomDomain("example",
        name="example-customDomain",
        cdn_frontdoor_profile_id=example_frontdoor_profile.id,
        dns_zone_id=example_zone.id,
        host_name="contoso.fabrikam.com",
        tls=azure.cdn.FrontdoorCustomDomainTlsArgs(
            certificate_type="ManagedCertificate",
            minimum_tls_version="TLS12",
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cdn"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/dns"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-cdn-frontdoor"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleZone, err := dns.NewZone(ctx, "example", &dns.ZoneArgs{
    			Name:              pulumi.String("sub-domain.domain.com"),
    			ResourceGroupName: example.Name,
    		})
    		if err != nil {
    			return err
    		}
    		exampleFrontdoorProfile, err := cdn.NewFrontdoorProfile(ctx, "example", &cdn.FrontdoorProfileArgs{
    			Name:              pulumi.String("example-profile"),
    			ResourceGroupName: example.Name,
    			SkuName:           pulumi.String("Standard_AzureFrontDoor"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = cdn.NewFrontdoorCustomDomain(ctx, "example", &cdn.FrontdoorCustomDomainArgs{
    			Name:                  pulumi.String("example-customDomain"),
    			CdnFrontdoorProfileId: exampleFrontdoorProfile.ID(),
    			DnsZoneId:             exampleZone.ID(),
    			HostName:              pulumi.String("contoso.fabrikam.com"),
    			Tls: &cdn.FrontdoorCustomDomainTlsArgs{
    				CertificateType:   pulumi.String("ManagedCertificate"),
    				MinimumTlsVersion: pulumi.String("TLS12"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-cdn-frontdoor",
            Location = "West Europe",
        });
    
        var exampleZone = new Azure.Dns.Zone("example", new()
        {
            Name = "sub-domain.domain.com",
            ResourceGroupName = example.Name,
        });
    
        var exampleFrontdoorProfile = new Azure.Cdn.FrontdoorProfile("example", new()
        {
            Name = "example-profile",
            ResourceGroupName = example.Name,
            SkuName = "Standard_AzureFrontDoor",
        });
    
        var exampleFrontdoorCustomDomain = new Azure.Cdn.FrontdoorCustomDomain("example", new()
        {
            Name = "example-customDomain",
            CdnFrontdoorProfileId = exampleFrontdoorProfile.Id,
            DnsZoneId = exampleZone.Id,
            HostName = "contoso.fabrikam.com",
            Tls = new Azure.Cdn.Inputs.FrontdoorCustomDomainTlsArgs
            {
                CertificateType = "ManagedCertificate",
                MinimumTlsVersion = "TLS12",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.dns.Zone;
    import com.pulumi.azure.dns.ZoneArgs;
    import com.pulumi.azure.cdn.FrontdoorProfile;
    import com.pulumi.azure.cdn.FrontdoorProfileArgs;
    import com.pulumi.azure.cdn.FrontdoorCustomDomain;
    import com.pulumi.azure.cdn.FrontdoorCustomDomainArgs;
    import com.pulumi.azure.cdn.inputs.FrontdoorCustomDomainTlsArgs;
    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-cdn-frontdoor")
                .location("West Europe")
                .build());
    
            var exampleZone = new Zone("exampleZone", ZoneArgs.builder()
                .name("sub-domain.domain.com")
                .resourceGroupName(example.name())
                .build());
    
            var exampleFrontdoorProfile = new FrontdoorProfile("exampleFrontdoorProfile", FrontdoorProfileArgs.builder()
                .name("example-profile")
                .resourceGroupName(example.name())
                .skuName("Standard_AzureFrontDoor")
                .build());
    
            var exampleFrontdoorCustomDomain = new FrontdoorCustomDomain("exampleFrontdoorCustomDomain", FrontdoorCustomDomainArgs.builder()
                .name("example-customDomain")
                .cdnFrontdoorProfileId(exampleFrontdoorProfile.id())
                .dnsZoneId(exampleZone.id())
                .hostName("contoso.fabrikam.com")
                .tls(FrontdoorCustomDomainTlsArgs.builder()
                    .certificateType("ManagedCertificate")
                    .minimumTlsVersion("TLS12")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-cdn-frontdoor
          location: West Europe
      exampleZone:
        type: azure:dns:Zone
        name: example
        properties:
          name: sub-domain.domain.com
          resourceGroupName: ${example.name}
      exampleFrontdoorProfile:
        type: azure:cdn:FrontdoorProfile
        name: example
        properties:
          name: example-profile
          resourceGroupName: ${example.name}
          skuName: Standard_AzureFrontDoor
      exampleFrontdoorCustomDomain:
        type: azure:cdn:FrontdoorCustomDomain
        name: example
        properties:
          name: example-customDomain
          cdnFrontdoorProfileId: ${exampleFrontdoorProfile.id}
          dnsZoneId: ${exampleZone.id}
          hostName: contoso.fabrikam.com
          tls:
            certificateType: ManagedCertificate
            minimumTlsVersion: TLS12
    

    Example DNS Auth TXT Record Usage

    The name of your DNS TXT record should be in the format of _dnsauth.<your_subdomain>. So, for example, if we use the host_name in the example usage above you would create a DNS TXT record with the name of _dnsauth.contoso which contains the value of the Front Door Custom Domains validation_token field. See the product documentation for more information.

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    import * as std from "@pulumi/std";
    
    const example = new azure.dns.TxtRecord("example", {
        name: std.join({
            separator: ".",
            input: [
                "_dnsauth",
                "contoso",
            ],
        }).then(invoke => invoke.result),
        zoneName: exampleAzurermDnsZone.name,
        resourceGroupName: exampleAzurermResourceGroup.name,
        ttl: 3600,
        records: [{
            value: exampleAzurermCdnFrontdoorCustomDomain.validationToken,
        }],
    });
    
    import pulumi
    import pulumi_azure as azure
    import pulumi_std as std
    
    example = azure.dns.TxtRecord("example",
        name=std.join(separator=".",
            input=[
                "_dnsauth",
                "contoso",
            ]).result,
        zone_name=example_azurerm_dns_zone["name"],
        resource_group_name=example_azurerm_resource_group["name"],
        ttl=3600,
        records=[azure.dns.TxtRecordRecordArgs(
            value=example_azurerm_cdn_frontdoor_custom_domain["validationToken"],
        )])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/dns"
    	"github.com/pulumi/pulumi-std/sdk/go/std"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		invokeJoin, err := std.Join(ctx, &std.JoinArgs{
    			Separator: ".",
    			Input: []string{
    				"_dnsauth",
    				"contoso",
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = dns.NewTxtRecord(ctx, "example", &dns.TxtRecordArgs{
    			Name:              invokeJoin.Result,
    			ZoneName:          pulumi.Any(exampleAzurermDnsZone.Name),
    			ResourceGroupName: pulumi.Any(exampleAzurermResourceGroup.Name),
    			Ttl:               pulumi.Int(3600),
    			Records: dns.TxtRecordRecordArray{
    				&dns.TxtRecordRecordArgs{
    					Value: pulumi.Any(exampleAzurermCdnFrontdoorCustomDomain.ValidationToken),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    using Std = Pulumi.Std;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Dns.TxtRecord("example", new()
        {
            Name = Std.Join.Invoke(new()
            {
                Separator = ".",
                Input = new[]
                {
                    "_dnsauth",
                    "contoso",
                },
            }).Apply(invoke => invoke.Result),
            ZoneName = exampleAzurermDnsZone.Name,
            ResourceGroupName = exampleAzurermResourceGroup.Name,
            Ttl = 3600,
            Records = new[]
            {
                new Azure.Dns.Inputs.TxtRecordRecordArgs
                {
                    Value = exampleAzurermCdnFrontdoorCustomDomain.ValidationToken,
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.dns.TxtRecord;
    import com.pulumi.azure.dns.TxtRecordArgs;
    import com.pulumi.azure.dns.inputs.TxtRecordRecordArgs;
    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 example = new TxtRecord("example", TxtRecordArgs.builder()
                .name(StdFunctions.join(JoinArgs.builder()
                    .separator(".")
                    .input(                
                        "_dnsauth",
                        "contoso")
                    .build()).result())
                .zoneName(exampleAzurermDnsZone.name())
                .resourceGroupName(exampleAzurermResourceGroup.name())
                .ttl(3600)
                .records(TxtRecordRecordArgs.builder()
                    .value(exampleAzurermCdnFrontdoorCustomDomain.validationToken())
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:dns:TxtRecord
        properties:
          name:
            fn::invoke:
              Function: std:join
              Arguments:
                separator: .
                input:
                  - _dnsauth
                  - contoso
              Return: result
          zoneName: ${exampleAzurermDnsZone.name}
          resourceGroupName: ${exampleAzurermResourceGroup.name}
          ttl: 3600
          records:
            - value: ${exampleAzurermCdnFrontdoorCustomDomain.validationToken}
    

    Example CNAME Record Usage

    !>IMPORTANT: You must include the depends_on meta-argument which references both the azure.cdn.FrontdoorRoute and the azure.cdn.FrontdoorSecurityPolicy that are associated with your Custom Domain. The reason for these depends_on meta-arguments is because all of the resources for the Custom Domain need to be associated within Front Door before the CNAME record can be written to the domains DNS, else the CNAME validation will fail and Front Door will not enable traffic to the Domain.

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.dns.CNameRecord("example", {
        name: "contoso",
        zoneName: exampleAzurermDnsZone.name,
        resourceGroupName: exampleAzurermResourceGroup.name,
        ttl: 3600,
        record: exampleAzurermCdnFrontdoorEndpoint.hostName,
    }, {
        dependsOn: [
            exampleAzurermCdnFrontdoorRoute,
            exampleAzurermCdnFrontdoorSecurityPolicy,
        ],
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.dns.CNameRecord("example",
        name="contoso",
        zone_name=example_azurerm_dns_zone["name"],
        resource_group_name=example_azurerm_resource_group["name"],
        ttl=3600,
        record=example_azurerm_cdn_frontdoor_endpoint["hostName"],
        opts=pulumi.ResourceOptions(depends_on=[
                example_azurerm_cdn_frontdoor_route,
                example_azurerm_cdn_frontdoor_security_policy,
            ]))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/dns"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dns.NewCNameRecord(ctx, "example", &dns.CNameRecordArgs{
    			Name:              pulumi.String("contoso"),
    			ZoneName:          pulumi.Any(exampleAzurermDnsZone.Name),
    			ResourceGroupName: pulumi.Any(exampleAzurermResourceGroup.Name),
    			Ttl:               pulumi.Int(3600),
    			Record:            pulumi.Any(exampleAzurermCdnFrontdoorEndpoint.HostName),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			exampleAzurermCdnFrontdoorRoute,
    			exampleAzurermCdnFrontdoorSecurityPolicy,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Dns.CNameRecord("example", new()
        {
            Name = "contoso",
            ZoneName = exampleAzurermDnsZone.Name,
            ResourceGroupName = exampleAzurermResourceGroup.Name,
            Ttl = 3600,
            Record = exampleAzurermCdnFrontdoorEndpoint.HostName,
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                exampleAzurermCdnFrontdoorRoute,
                exampleAzurermCdnFrontdoorSecurityPolicy,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.dns.CNameRecord;
    import com.pulumi.azure.dns.CNameRecordArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 example = new CNameRecord("example", CNameRecordArgs.builder()
                .name("contoso")
                .zoneName(exampleAzurermDnsZone.name())
                .resourceGroupName(exampleAzurermResourceGroup.name())
                .ttl(3600)
                .record(exampleAzurermCdnFrontdoorEndpoint.hostName())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(                
                        exampleAzurermCdnFrontdoorRoute,
                        exampleAzurermCdnFrontdoorSecurityPolicy)
                    .build());
    
        }
    }
    
    resources:
      example:
        type: azure:dns:CNameRecord
        properties:
          name: contoso
          zoneName: ${exampleAzurermDnsZone.name}
          resourceGroupName: ${exampleAzurermResourceGroup.name}
          ttl: 3600
          record: ${exampleAzurermCdnFrontdoorEndpoint.hostName}
        options:
          dependson:
            - ${exampleAzurermCdnFrontdoorRoute}
            - ${exampleAzurermCdnFrontdoorSecurityPolicy}
    

    Create FrontdoorCustomDomain Resource

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

    Constructor syntax

    new FrontdoorCustomDomain(name: string, args: FrontdoorCustomDomainArgs, opts?: CustomResourceOptions);
    @overload
    def FrontdoorCustomDomain(resource_name: str,
                              args: FrontdoorCustomDomainArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def FrontdoorCustomDomain(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              cdn_frontdoor_profile_id: Optional[str] = None,
                              host_name: Optional[str] = None,
                              tls: Optional[FrontdoorCustomDomainTlsArgs] = None,
                              dns_zone_id: Optional[str] = None,
                              name: Optional[str] = None)
    func NewFrontdoorCustomDomain(ctx *Context, name string, args FrontdoorCustomDomainArgs, opts ...ResourceOption) (*FrontdoorCustomDomain, error)
    public FrontdoorCustomDomain(string name, FrontdoorCustomDomainArgs args, CustomResourceOptions? opts = null)
    public FrontdoorCustomDomain(String name, FrontdoorCustomDomainArgs args)
    public FrontdoorCustomDomain(String name, FrontdoorCustomDomainArgs args, CustomResourceOptions options)
    
    type: azure:cdn:FrontdoorCustomDomain
    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 FrontdoorCustomDomainArgs
    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 FrontdoorCustomDomainArgs
    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 FrontdoorCustomDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FrontdoorCustomDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FrontdoorCustomDomainArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var frontdoorCustomDomainResource = new Azure.Cdn.FrontdoorCustomDomain("frontdoorCustomDomainResource", new()
    {
        CdnFrontdoorProfileId = "string",
        HostName = "string",
        Tls = new Azure.Cdn.Inputs.FrontdoorCustomDomainTlsArgs
        {
            CdnFrontdoorSecretId = "string",
            CertificateType = "string",
            MinimumTlsVersion = "string",
        },
        DnsZoneId = "string",
        Name = "string",
    });
    
    example, err := cdn.NewFrontdoorCustomDomain(ctx, "frontdoorCustomDomainResource", &cdn.FrontdoorCustomDomainArgs{
    	CdnFrontdoorProfileId: pulumi.String("string"),
    	HostName:              pulumi.String("string"),
    	Tls: &cdn.FrontdoorCustomDomainTlsArgs{
    		CdnFrontdoorSecretId: pulumi.String("string"),
    		CertificateType:      pulumi.String("string"),
    		MinimumTlsVersion:    pulumi.String("string"),
    	},
    	DnsZoneId: pulumi.String("string"),
    	Name:      pulumi.String("string"),
    })
    
    var frontdoorCustomDomainResource = new FrontdoorCustomDomain("frontdoorCustomDomainResource", FrontdoorCustomDomainArgs.builder()
        .cdnFrontdoorProfileId("string")
        .hostName("string")
        .tls(FrontdoorCustomDomainTlsArgs.builder()
            .cdnFrontdoorSecretId("string")
            .certificateType("string")
            .minimumTlsVersion("string")
            .build())
        .dnsZoneId("string")
        .name("string")
        .build());
    
    frontdoor_custom_domain_resource = azure.cdn.FrontdoorCustomDomain("frontdoorCustomDomainResource",
        cdn_frontdoor_profile_id="string",
        host_name="string",
        tls=azure.cdn.FrontdoorCustomDomainTlsArgs(
            cdn_frontdoor_secret_id="string",
            certificate_type="string",
            minimum_tls_version="string",
        ),
        dns_zone_id="string",
        name="string")
    
    const frontdoorCustomDomainResource = new azure.cdn.FrontdoorCustomDomain("frontdoorCustomDomainResource", {
        cdnFrontdoorProfileId: "string",
        hostName: "string",
        tls: {
            cdnFrontdoorSecretId: "string",
            certificateType: "string",
            minimumTlsVersion: "string",
        },
        dnsZoneId: "string",
        name: "string",
    });
    
    type: azure:cdn:FrontdoorCustomDomain
    properties:
        cdnFrontdoorProfileId: string
        dnsZoneId: string
        hostName: string
        name: string
        tls:
            cdnFrontdoorSecretId: string
            certificateType: string
            minimumTlsVersion: string
    

    FrontdoorCustomDomain 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 FrontdoorCustomDomain resource accepts the following input properties:

    CdnFrontdoorProfileId string
    The ID of the Front Door Profile. Changing this forces a new Front Door Custom Domain to be created.
    HostName string
    The host name of the domain. The host_name field must be the FQDN of your domain(e.g. contoso.fabrikam.com). Changing this forces a new Front Door Custom Domain to be created.
    Tls FrontdoorCustomDomainTls
    A tls block as defined below.
    DnsZoneId string
    The ID of the Azure DNS Zone which should be used for this Front Door Custom Domain. If you are using Azure to host your DNS domains, you must delegate the domain provider's domain name system (DNS) to an Azure DNS Zone. For more information, see Delegate a domain to Azure DNS. Otherwise, if you're using your own domain provider to handle your DNS, you must validate the Front Door Custom Domain by creating the DNS TXT records manually.

    Name string
    The name which should be used for this Front Door Custom Domain. Possible values must be between 2 and 260 characters in length, must begin with a letter or number, end with a letter or number and contain only letters, numbers and hyphens. Changing this forces a new Front Door Custom Domain to be created.
    CdnFrontdoorProfileId string
    The ID of the Front Door Profile. Changing this forces a new Front Door Custom Domain to be created.
    HostName string
    The host name of the domain. The host_name field must be the FQDN of your domain(e.g. contoso.fabrikam.com). Changing this forces a new Front Door Custom Domain to be created.
    Tls FrontdoorCustomDomainTlsArgs
    A tls block as defined below.
    DnsZoneId string
    The ID of the Azure DNS Zone which should be used for this Front Door Custom Domain. If you are using Azure to host your DNS domains, you must delegate the domain provider's domain name system (DNS) to an Azure DNS Zone. For more information, see Delegate a domain to Azure DNS. Otherwise, if you're using your own domain provider to handle your DNS, you must validate the Front Door Custom Domain by creating the DNS TXT records manually.

    Name string
    The name which should be used for this Front Door Custom Domain. Possible values must be between 2 and 260 characters in length, must begin with a letter or number, end with a letter or number and contain only letters, numbers and hyphens. Changing this forces a new Front Door Custom Domain to be created.
    cdnFrontdoorProfileId String
    The ID of the Front Door Profile. Changing this forces a new Front Door Custom Domain to be created.
    hostName String
    The host name of the domain. The host_name field must be the FQDN of your domain(e.g. contoso.fabrikam.com). Changing this forces a new Front Door Custom Domain to be created.
    tls FrontdoorCustomDomainTls
    A tls block as defined below.
    dnsZoneId String
    The ID of the Azure DNS Zone which should be used for this Front Door Custom Domain. If you are using Azure to host your DNS domains, you must delegate the domain provider's domain name system (DNS) to an Azure DNS Zone. For more information, see Delegate a domain to Azure DNS. Otherwise, if you're using your own domain provider to handle your DNS, you must validate the Front Door Custom Domain by creating the DNS TXT records manually.

    name String
    The name which should be used for this Front Door Custom Domain. Possible values must be between 2 and 260 characters in length, must begin with a letter or number, end with a letter or number and contain only letters, numbers and hyphens. Changing this forces a new Front Door Custom Domain to be created.
    cdnFrontdoorProfileId string
    The ID of the Front Door Profile. Changing this forces a new Front Door Custom Domain to be created.
    hostName string
    The host name of the domain. The host_name field must be the FQDN of your domain(e.g. contoso.fabrikam.com). Changing this forces a new Front Door Custom Domain to be created.
    tls FrontdoorCustomDomainTls
    A tls block as defined below.
    dnsZoneId string
    The ID of the Azure DNS Zone which should be used for this Front Door Custom Domain. If you are using Azure to host your DNS domains, you must delegate the domain provider's domain name system (DNS) to an Azure DNS Zone. For more information, see Delegate a domain to Azure DNS. Otherwise, if you're using your own domain provider to handle your DNS, you must validate the Front Door Custom Domain by creating the DNS TXT records manually.

    name string
    The name which should be used for this Front Door Custom Domain. Possible values must be between 2 and 260 characters in length, must begin with a letter or number, end with a letter or number and contain only letters, numbers and hyphens. Changing this forces a new Front Door Custom Domain to be created.
    cdn_frontdoor_profile_id str
    The ID of the Front Door Profile. Changing this forces a new Front Door Custom Domain to be created.
    host_name str
    The host name of the domain. The host_name field must be the FQDN of your domain(e.g. contoso.fabrikam.com). Changing this forces a new Front Door Custom Domain to be created.
    tls FrontdoorCustomDomainTlsArgs
    A tls block as defined below.
    dns_zone_id str
    The ID of the Azure DNS Zone which should be used for this Front Door Custom Domain. If you are using Azure to host your DNS domains, you must delegate the domain provider's domain name system (DNS) to an Azure DNS Zone. For more information, see Delegate a domain to Azure DNS. Otherwise, if you're using your own domain provider to handle your DNS, you must validate the Front Door Custom Domain by creating the DNS TXT records manually.

    name str
    The name which should be used for this Front Door Custom Domain. Possible values must be between 2 and 260 characters in length, must begin with a letter or number, end with a letter or number and contain only letters, numbers and hyphens. Changing this forces a new Front Door Custom Domain to be created.
    cdnFrontdoorProfileId String
    The ID of the Front Door Profile. Changing this forces a new Front Door Custom Domain to be created.
    hostName String
    The host name of the domain. The host_name field must be the FQDN of your domain(e.g. contoso.fabrikam.com). Changing this forces a new Front Door Custom Domain to be created.
    tls Property Map
    A tls block as defined below.
    dnsZoneId String
    The ID of the Azure DNS Zone which should be used for this Front Door Custom Domain. If you are using Azure to host your DNS domains, you must delegate the domain provider's domain name system (DNS) to an Azure DNS Zone. For more information, see Delegate a domain to Azure DNS. Otherwise, if you're using your own domain provider to handle your DNS, you must validate the Front Door Custom Domain by creating the DNS TXT records manually.

    name String
    The name which should be used for this Front Door Custom Domain. Possible values must be between 2 and 260 characters in length, must begin with a letter or number, end with a letter or number and contain only letters, numbers and hyphens. Changing this forces a new Front Door Custom Domain to be created.

    Outputs

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

    ExpirationDate string
    The date time that the token expires.
    Id string
    The provider-assigned unique ID for this managed resource.
    ValidationToken string
    Challenge used for DNS TXT record or file based validation.
    ExpirationDate string
    The date time that the token expires.
    Id string
    The provider-assigned unique ID for this managed resource.
    ValidationToken string
    Challenge used for DNS TXT record or file based validation.
    expirationDate String
    The date time that the token expires.
    id String
    The provider-assigned unique ID for this managed resource.
    validationToken String
    Challenge used for DNS TXT record or file based validation.
    expirationDate string
    The date time that the token expires.
    id string
    The provider-assigned unique ID for this managed resource.
    validationToken string
    Challenge used for DNS TXT record or file based validation.
    expiration_date str
    The date time that the token expires.
    id str
    The provider-assigned unique ID for this managed resource.
    validation_token str
    Challenge used for DNS TXT record or file based validation.
    expirationDate String
    The date time that the token expires.
    id String
    The provider-assigned unique ID for this managed resource.
    validationToken String
    Challenge used for DNS TXT record or file based validation.

    Look up Existing FrontdoorCustomDomain Resource

    Get an existing FrontdoorCustomDomain 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?: FrontdoorCustomDomainState, opts?: CustomResourceOptions): FrontdoorCustomDomain
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cdn_frontdoor_profile_id: Optional[str] = None,
            dns_zone_id: Optional[str] = None,
            expiration_date: Optional[str] = None,
            host_name: Optional[str] = None,
            name: Optional[str] = None,
            tls: Optional[FrontdoorCustomDomainTlsArgs] = None,
            validation_token: Optional[str] = None) -> FrontdoorCustomDomain
    func GetFrontdoorCustomDomain(ctx *Context, name string, id IDInput, state *FrontdoorCustomDomainState, opts ...ResourceOption) (*FrontdoorCustomDomain, error)
    public static FrontdoorCustomDomain Get(string name, Input<string> id, FrontdoorCustomDomainState? state, CustomResourceOptions? opts = null)
    public static FrontdoorCustomDomain get(String name, Output<String> id, FrontdoorCustomDomainState 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:
    CdnFrontdoorProfileId string
    The ID of the Front Door Profile. Changing this forces a new Front Door Custom Domain to be created.
    DnsZoneId string
    The ID of the Azure DNS Zone which should be used for this Front Door Custom Domain. If you are using Azure to host your DNS domains, you must delegate the domain provider's domain name system (DNS) to an Azure DNS Zone. For more information, see Delegate a domain to Azure DNS. Otherwise, if you're using your own domain provider to handle your DNS, you must validate the Front Door Custom Domain by creating the DNS TXT records manually.

    ExpirationDate string
    The date time that the token expires.
    HostName string
    The host name of the domain. The host_name field must be the FQDN of your domain(e.g. contoso.fabrikam.com). Changing this forces a new Front Door Custom Domain to be created.
    Name string
    The name which should be used for this Front Door Custom Domain. Possible values must be between 2 and 260 characters in length, must begin with a letter or number, end with a letter or number and contain only letters, numbers and hyphens. Changing this forces a new Front Door Custom Domain to be created.
    Tls FrontdoorCustomDomainTls
    A tls block as defined below.
    ValidationToken string
    Challenge used for DNS TXT record or file based validation.
    CdnFrontdoorProfileId string
    The ID of the Front Door Profile. Changing this forces a new Front Door Custom Domain to be created.
    DnsZoneId string
    The ID of the Azure DNS Zone which should be used for this Front Door Custom Domain. If you are using Azure to host your DNS domains, you must delegate the domain provider's domain name system (DNS) to an Azure DNS Zone. For more information, see Delegate a domain to Azure DNS. Otherwise, if you're using your own domain provider to handle your DNS, you must validate the Front Door Custom Domain by creating the DNS TXT records manually.

    ExpirationDate string
    The date time that the token expires.
    HostName string
    The host name of the domain. The host_name field must be the FQDN of your domain(e.g. contoso.fabrikam.com). Changing this forces a new Front Door Custom Domain to be created.
    Name string
    The name which should be used for this Front Door Custom Domain. Possible values must be between 2 and 260 characters in length, must begin with a letter or number, end with a letter or number and contain only letters, numbers and hyphens. Changing this forces a new Front Door Custom Domain to be created.
    Tls FrontdoorCustomDomainTlsArgs
    A tls block as defined below.
    ValidationToken string
    Challenge used for DNS TXT record or file based validation.
    cdnFrontdoorProfileId String
    The ID of the Front Door Profile. Changing this forces a new Front Door Custom Domain to be created.
    dnsZoneId String
    The ID of the Azure DNS Zone which should be used for this Front Door Custom Domain. If you are using Azure to host your DNS domains, you must delegate the domain provider's domain name system (DNS) to an Azure DNS Zone. For more information, see Delegate a domain to Azure DNS. Otherwise, if you're using your own domain provider to handle your DNS, you must validate the Front Door Custom Domain by creating the DNS TXT records manually.

    expirationDate String
    The date time that the token expires.
    hostName String
    The host name of the domain. The host_name field must be the FQDN of your domain(e.g. contoso.fabrikam.com). Changing this forces a new Front Door Custom Domain to be created.
    name String
    The name which should be used for this Front Door Custom Domain. Possible values must be between 2 and 260 characters in length, must begin with a letter or number, end with a letter or number and contain only letters, numbers and hyphens. Changing this forces a new Front Door Custom Domain to be created.
    tls FrontdoorCustomDomainTls
    A tls block as defined below.
    validationToken String
    Challenge used for DNS TXT record or file based validation.
    cdnFrontdoorProfileId string
    The ID of the Front Door Profile. Changing this forces a new Front Door Custom Domain to be created.
    dnsZoneId string
    The ID of the Azure DNS Zone which should be used for this Front Door Custom Domain. If you are using Azure to host your DNS domains, you must delegate the domain provider's domain name system (DNS) to an Azure DNS Zone. For more information, see Delegate a domain to Azure DNS. Otherwise, if you're using your own domain provider to handle your DNS, you must validate the Front Door Custom Domain by creating the DNS TXT records manually.

    expirationDate string
    The date time that the token expires.
    hostName string
    The host name of the domain. The host_name field must be the FQDN of your domain(e.g. contoso.fabrikam.com). Changing this forces a new Front Door Custom Domain to be created.
    name string
    The name which should be used for this Front Door Custom Domain. Possible values must be between 2 and 260 characters in length, must begin with a letter or number, end with a letter or number and contain only letters, numbers and hyphens. Changing this forces a new Front Door Custom Domain to be created.
    tls FrontdoorCustomDomainTls
    A tls block as defined below.
    validationToken string
    Challenge used for DNS TXT record or file based validation.
    cdn_frontdoor_profile_id str
    The ID of the Front Door Profile. Changing this forces a new Front Door Custom Domain to be created.
    dns_zone_id str
    The ID of the Azure DNS Zone which should be used for this Front Door Custom Domain. If you are using Azure to host your DNS domains, you must delegate the domain provider's domain name system (DNS) to an Azure DNS Zone. For more information, see Delegate a domain to Azure DNS. Otherwise, if you're using your own domain provider to handle your DNS, you must validate the Front Door Custom Domain by creating the DNS TXT records manually.

    expiration_date str
    The date time that the token expires.
    host_name str
    The host name of the domain. The host_name field must be the FQDN of your domain(e.g. contoso.fabrikam.com). Changing this forces a new Front Door Custom Domain to be created.
    name str
    The name which should be used for this Front Door Custom Domain. Possible values must be between 2 and 260 characters in length, must begin with a letter or number, end with a letter or number and contain only letters, numbers and hyphens. Changing this forces a new Front Door Custom Domain to be created.
    tls FrontdoorCustomDomainTlsArgs
    A tls block as defined below.
    validation_token str
    Challenge used for DNS TXT record or file based validation.
    cdnFrontdoorProfileId String
    The ID of the Front Door Profile. Changing this forces a new Front Door Custom Domain to be created.
    dnsZoneId String
    The ID of the Azure DNS Zone which should be used for this Front Door Custom Domain. If you are using Azure to host your DNS domains, you must delegate the domain provider's domain name system (DNS) to an Azure DNS Zone. For more information, see Delegate a domain to Azure DNS. Otherwise, if you're using your own domain provider to handle your DNS, you must validate the Front Door Custom Domain by creating the DNS TXT records manually.

    expirationDate String
    The date time that the token expires.
    hostName String
    The host name of the domain. The host_name field must be the FQDN of your domain(e.g. contoso.fabrikam.com). Changing this forces a new Front Door Custom Domain to be created.
    name String
    The name which should be used for this Front Door Custom Domain. Possible values must be between 2 and 260 characters in length, must begin with a letter or number, end with a letter or number and contain only letters, numbers and hyphens. Changing this forces a new Front Door Custom Domain to be created.
    tls Property Map
    A tls block as defined below.
    validationToken String
    Challenge used for DNS TXT record or file based validation.

    Supporting Types

    FrontdoorCustomDomainTls, FrontdoorCustomDomainTlsArgs

    CdnFrontdoorSecretId string
    Resource ID of the Front Door Secret.
    CertificateType string

    Defines the source of the SSL certificate. Possible values include CustomerCertificate and ManagedCertificate. Defaults to ManagedCertificate.

    ->NOTE: It may take up to 15 minutes for the Front Door Service to validate the state and Domain ownership of the Custom Domain.

    MinimumTlsVersion string
    TLS protocol version that will be used for Https. Possible values include TLS10 and TLS12. Defaults to TLS12.
    CdnFrontdoorSecretId string
    Resource ID of the Front Door Secret.
    CertificateType string

    Defines the source of the SSL certificate. Possible values include CustomerCertificate and ManagedCertificate. Defaults to ManagedCertificate.

    ->NOTE: It may take up to 15 minutes for the Front Door Service to validate the state and Domain ownership of the Custom Domain.

    MinimumTlsVersion string
    TLS protocol version that will be used for Https. Possible values include TLS10 and TLS12. Defaults to TLS12.
    cdnFrontdoorSecretId String
    Resource ID of the Front Door Secret.
    certificateType String

    Defines the source of the SSL certificate. Possible values include CustomerCertificate and ManagedCertificate. Defaults to ManagedCertificate.

    ->NOTE: It may take up to 15 minutes for the Front Door Service to validate the state and Domain ownership of the Custom Domain.

    minimumTlsVersion String
    TLS protocol version that will be used for Https. Possible values include TLS10 and TLS12. Defaults to TLS12.
    cdnFrontdoorSecretId string
    Resource ID of the Front Door Secret.
    certificateType string

    Defines the source of the SSL certificate. Possible values include CustomerCertificate and ManagedCertificate. Defaults to ManagedCertificate.

    ->NOTE: It may take up to 15 minutes for the Front Door Service to validate the state and Domain ownership of the Custom Domain.

    minimumTlsVersion string
    TLS protocol version that will be used for Https. Possible values include TLS10 and TLS12. Defaults to TLS12.
    cdn_frontdoor_secret_id str
    Resource ID of the Front Door Secret.
    certificate_type str

    Defines the source of the SSL certificate. Possible values include CustomerCertificate and ManagedCertificate. Defaults to ManagedCertificate.

    ->NOTE: It may take up to 15 minutes for the Front Door Service to validate the state and Domain ownership of the Custom Domain.

    minimum_tls_version str
    TLS protocol version that will be used for Https. Possible values include TLS10 and TLS12. Defaults to TLS12.
    cdnFrontdoorSecretId String
    Resource ID of the Front Door Secret.
    certificateType String

    Defines the source of the SSL certificate. Possible values include CustomerCertificate and ManagedCertificate. Defaults to ManagedCertificate.

    ->NOTE: It may take up to 15 minutes for the Front Door Service to validate the state and Domain ownership of the Custom Domain.

    minimumTlsVersion String
    TLS protocol version that will be used for Https. Possible values include TLS10 and TLS12. Defaults to TLS12.

    Import

    Front Door Custom Domains can be imported using the resource id, e.g.

    $ pulumi import azure:cdn/frontdoorCustomDomain:FrontdoorCustomDomain example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Cdn/profiles/profile1/customDomains/customDomain1
    

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

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi