Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. frontdoor
  5. CustomHttpsConfiguration

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.frontdoor.CustomHttpsConfiguration

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    !> IMPORTANT This deploys an Azure Front Door (classic) resource which has been deprecated and will receive security updates only. Please migrate your existing Azure Front Door (classic) deployments to the new Azure Front Door (standard/premium) resources. For your convenience, the service team has exposed a Front Door Classic to Front Door Standard/Premium migration tool to allow you to migrate your existing Front Door Classic instances to the new Front Door Standard/Premium product tiers.

    Manages the Custom HTTPS Configuration for an Azure Front Door (classic) Frontend Endpoint.

    NOTE: Defining custom HTTPS configurations using a separate azure.frontdoor.CustomHttpsConfiguration resource allows for parallel creation/update.

    !> BREAKING CHANGE: In order to address the ordering issue we have changed the design on how to retrieve existing sub resources such as frontend endpoints. Existing design will be deprecated and will result in an incorrect configuration. Please refer to the updated documentation below for more information.

    !> BREAKING CHANGE: The resource_group_name field has been removed as of the v2.58.0 provider release. If the resource_group_name field has been defined in your current azure.frontdoor.CustomHttpsConfiguration resource configuration file please remove it else you will receive a An argument named "resource_group_name" is not expected here. error. If your pre-existing Front Door instance contained inline custom_https_configuration blocks there are additional steps that will need to be completed to successfully migrate your Front Door onto the v2.58.0 provider which can be found in this guide.

    !> Be Aware: Azure is rolling out a breaking change on Friday 9th April 2021 which may cause issues with the CDN/FrontDoor resources. More information is available in this GitHub issue - however unfortunately this may necessitate a breaking change to the CDN and Front Door resources, more information will be posted in the GitHub issue as the necessary changes are identified.

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "FrontDoorExampleResourceGroup",
    location: "West Europe",
});
const vault = azure.keyvault.getKeyVault({
    name: "example-vault",
    resourceGroupName: "example-vault-rg",
});
const exampleFrontdoor = new azure.frontdoor.Frontdoor("example", {
    name: "example-FrontDoor",
    resourceGroupName: example.name,
    routingRules: [{
        name: "exampleRoutingRule1",
        acceptedProtocols: [
            "Http",
            "Https",
        ],
        patternsToMatches: ["/*"],
        frontendEndpoints: ["exampleFrontendEndpoint1"],
        forwardingConfiguration: {
            forwardingProtocol: "MatchRequest",
            backendPoolName: "exampleBackendBing",
        },
    }],
    backendPoolLoadBalancings: [{
        name: "exampleLoadBalancingSettings1",
    }],
    backendPoolHealthProbes: [{
        name: "exampleHealthProbeSetting1",
    }],
    backendPools: [{
        name: "exampleBackendBing",
        backends: [{
            hostHeader: "www.bing.com",
            address: "www.bing.com",
            httpPort: 80,
            httpsPort: 443,
        }],
        loadBalancingName: "exampleLoadBalancingSettings1",
        healthProbeName: "exampleHealthProbeSetting1",
    }],
    frontendEndpoints: [
        {
            name: "exampleFrontendEndpoint1",
            hostName: "example-FrontDoor.azurefd.net",
        },
        {
            name: "exampleFrontendEndpoint2",
            hostName: "examplefd1.examplefd.net",
        },
    ],
});
const exampleCustomHttps0 = new azure.frontdoor.CustomHttpsConfiguration("example_custom_https_0", {
    frontendEndpointId: exampleFrontdoor.frontendEndpointsMap.exampleFrontendEndpoint1,
    customHttpsProvisioningEnabled: false,
});
const exampleCustomHttps1 = new azure.frontdoor.CustomHttpsConfiguration("example_custom_https_1", {
    frontendEndpointId: exampleFrontdoor.frontendEndpointsMap.exampleFrontendEndpoint2,
    customHttpsProvisioningEnabled: true,
    customHttpsConfiguration: {
        certificateSource: "AzureKeyVault",
        azureKeyVaultCertificateSecretName: "examplefd1",
        azureKeyVaultCertificateVaultId: vault.then(vault => vault.id),
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="FrontDoorExampleResourceGroup",
    location="West Europe")
vault = azure.keyvault.get_key_vault(name="example-vault",
    resource_group_name="example-vault-rg")
example_frontdoor = azure.frontdoor.Frontdoor("example",
    name="example-FrontDoor",
    resource_group_name=example.name,
    routing_rules=[{
        "name": "exampleRoutingRule1",
        "accepted_protocols": [
            "Http",
            "Https",
        ],
        "patterns_to_matches": ["/*"],
        "frontend_endpoints": ["exampleFrontendEndpoint1"],
        "forwarding_configuration": {
            "forwarding_protocol": "MatchRequest",
            "backend_pool_name": "exampleBackendBing",
        },
    }],
    backend_pool_load_balancings=[{
        "name": "exampleLoadBalancingSettings1",
    }],
    backend_pool_health_probes=[{
        "name": "exampleHealthProbeSetting1",
    }],
    backend_pools=[{
        "name": "exampleBackendBing",
        "backends": [{
            "host_header": "www.bing.com",
            "address": "www.bing.com",
            "http_port": 80,
            "https_port": 443,
        }],
        "load_balancing_name": "exampleLoadBalancingSettings1",
        "health_probe_name": "exampleHealthProbeSetting1",
    }],
    frontend_endpoints=[
        {
            "name": "exampleFrontendEndpoint1",
            "host_name": "example-FrontDoor.azurefd.net",
        },
        {
            "name": "exampleFrontendEndpoint2",
            "host_name": "examplefd1.examplefd.net",
        },
    ])
example_custom_https0 = azure.frontdoor.CustomHttpsConfiguration("example_custom_https_0",
    frontend_endpoint_id=example_frontdoor.frontend_endpoints_map["exampleFrontendEndpoint1"],
    custom_https_provisioning_enabled=False)
example_custom_https1 = azure.frontdoor.CustomHttpsConfiguration("example_custom_https_1",
    frontend_endpoint_id=example_frontdoor.frontend_endpoints_map["exampleFrontendEndpoint2"],
    custom_https_provisioning_enabled=True,
    custom_https_configuration={
        "certificate_source": "AzureKeyVault",
        "azure_key_vault_certificate_secret_name": "examplefd1",
        "azure_key_vault_certificate_vault_id": vault.id,
    })

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/frontdoor"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/keyvault"
	"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("FrontDoorExampleResourceGroup"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		vault, err := keyvault.LookupKeyVault(ctx, &keyvault.LookupKeyVaultArgs{
			Name:              "example-vault",
			ResourceGroupName: "example-vault-rg",
		}, nil)
		if err != nil {
			return err
		}
		exampleFrontdoor, err := frontdoor.NewFrontdoor(ctx, "example", &frontdoor.FrontdoorArgs{
			Name:              pulumi.String("example-FrontDoor"),
			ResourceGroupName: example.Name,
			RoutingRules: frontdoor.FrontdoorRoutingRuleArray{
				&frontdoor.FrontdoorRoutingRuleArgs{
					Name: pulumi.String("exampleRoutingRule1"),
					AcceptedProtocols: pulumi.StringArray{
						pulumi.String("Http"),
						pulumi.String("Https"),
					},
					PatternsToMatches: pulumi.StringArray{
						pulumi.String("/*"),
					},
					FrontendEndpoints: pulumi.StringArray{
						pulumi.String("exampleFrontendEndpoint1"),
					},
					ForwardingConfiguration: &frontdoor.FrontdoorRoutingRuleForwardingConfigurationArgs{
						ForwardingProtocol: pulumi.String("MatchRequest"),
						BackendPoolName:    pulumi.String("exampleBackendBing"),
					},
				},
			},
			BackendPoolLoadBalancings: frontdoor.FrontdoorBackendPoolLoadBalancingArray{
				&frontdoor.FrontdoorBackendPoolLoadBalancingArgs{
					Name: pulumi.String("exampleLoadBalancingSettings1"),
				},
			},
			BackendPoolHealthProbes: frontdoor.FrontdoorBackendPoolHealthProbeArray{
				&frontdoor.FrontdoorBackendPoolHealthProbeArgs{
					Name: pulumi.String("exampleHealthProbeSetting1"),
				},
			},
			BackendPools: frontdoor.FrontdoorBackendPoolArray{
				&frontdoor.FrontdoorBackendPoolArgs{
					Name: pulumi.String("exampleBackendBing"),
					Backends: frontdoor.FrontdoorBackendPoolBackendArray{
						&frontdoor.FrontdoorBackendPoolBackendArgs{
							HostHeader: pulumi.String("www.bing.com"),
							Address:    pulumi.String("www.bing.com"),
							HttpPort:   pulumi.Int(80),
							HttpsPort:  pulumi.Int(443),
						},
					},
					LoadBalancingName: pulumi.String("exampleLoadBalancingSettings1"),
					HealthProbeName:   pulumi.String("exampleHealthProbeSetting1"),
				},
			},
			FrontendEndpoints: frontdoor.FrontdoorFrontendEndpointArray{
				&frontdoor.FrontdoorFrontendEndpointArgs{
					Name:     pulumi.String("exampleFrontendEndpoint1"),
					HostName: pulumi.String("example-FrontDoor.azurefd.net"),
				},
				&frontdoor.FrontdoorFrontendEndpointArgs{
					Name:     pulumi.String("exampleFrontendEndpoint2"),
					HostName: pulumi.String("examplefd1.examplefd.net"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = frontdoor.NewCustomHttpsConfiguration(ctx, "example_custom_https_0", &frontdoor.CustomHttpsConfigurationArgs{
			FrontendEndpointId: exampleFrontdoor.FrontendEndpointsMap.ApplyT(func(frontendEndpointsMap map[string]string) (string, error) {
				return frontendEndpointsMap.ExampleFrontendEndpoint1, nil
			}).(pulumi.StringOutput),
			CustomHttpsProvisioningEnabled: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = frontdoor.NewCustomHttpsConfiguration(ctx, "example_custom_https_1", &frontdoor.CustomHttpsConfigurationArgs{
			FrontendEndpointId: exampleFrontdoor.FrontendEndpointsMap.ApplyT(func(frontendEndpointsMap map[string]string) (string, error) {
				return frontendEndpointsMap.ExampleFrontendEndpoint2, nil
			}).(pulumi.StringOutput),
			CustomHttpsProvisioningEnabled: pulumi.Bool(true),
			CustomHttpsConfiguration: &frontdoor.CustomHttpsConfigurationCustomHttpsConfigurationArgs{
				CertificateSource:                  pulumi.String("AzureKeyVault"),
				AzureKeyVaultCertificateSecretName: pulumi.String("examplefd1"),
				AzureKeyVaultCertificateVaultId:    pulumi.String(vault.Id),
			},
		})
		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 = "FrontDoorExampleResourceGroup",
        Location = "West Europe",
    });

    var vault = Azure.KeyVault.GetKeyVault.Invoke(new()
    {
        Name = "example-vault",
        ResourceGroupName = "example-vault-rg",
    });

    var exampleFrontdoor = new Azure.FrontDoor.Frontdoor("example", new()
    {
        Name = "example-FrontDoor",
        ResourceGroupName = example.Name,
        RoutingRules = new[]
        {
            new Azure.FrontDoor.Inputs.FrontdoorRoutingRuleArgs
            {
                Name = "exampleRoutingRule1",
                AcceptedProtocols = new[]
                {
                    "Http",
                    "Https",
                },
                PatternsToMatches = new[]
                {
                    "/*",
                },
                FrontendEndpoints = new[]
                {
                    "exampleFrontendEndpoint1",
                },
                ForwardingConfiguration = new Azure.FrontDoor.Inputs.FrontdoorRoutingRuleForwardingConfigurationArgs
                {
                    ForwardingProtocol = "MatchRequest",
                    BackendPoolName = "exampleBackendBing",
                },
            },
        },
        BackendPoolLoadBalancings = new[]
        {
            new Azure.FrontDoor.Inputs.FrontdoorBackendPoolLoadBalancingArgs
            {
                Name = "exampleLoadBalancingSettings1",
            },
        },
        BackendPoolHealthProbes = new[]
        {
            new Azure.FrontDoor.Inputs.FrontdoorBackendPoolHealthProbeArgs
            {
                Name = "exampleHealthProbeSetting1",
            },
        },
        BackendPools = new[]
        {
            new Azure.FrontDoor.Inputs.FrontdoorBackendPoolArgs
            {
                Name = "exampleBackendBing",
                Backends = new[]
                {
                    new Azure.FrontDoor.Inputs.FrontdoorBackendPoolBackendArgs
                    {
                        HostHeader = "www.bing.com",
                        Address = "www.bing.com",
                        HttpPort = 80,
                        HttpsPort = 443,
                    },
                },
                LoadBalancingName = "exampleLoadBalancingSettings1",
                HealthProbeName = "exampleHealthProbeSetting1",
            },
        },
        FrontendEndpoints = new[]
        {
            new Azure.FrontDoor.Inputs.FrontdoorFrontendEndpointArgs
            {
                Name = "exampleFrontendEndpoint1",
                HostName = "example-FrontDoor.azurefd.net",
            },
            new Azure.FrontDoor.Inputs.FrontdoorFrontendEndpointArgs
            {
                Name = "exampleFrontendEndpoint2",
                HostName = "examplefd1.examplefd.net",
            },
        },
    });

    var exampleCustomHttps0 = new Azure.FrontDoor.CustomHttpsConfiguration("example_custom_https_0", new()
    {
        FrontendEndpointId = exampleFrontdoor.FrontendEndpointsMap.Apply(frontendEndpointsMap => frontendEndpointsMap.ExampleFrontendEndpoint1),
        CustomHttpsProvisioningEnabled = false,
    });

    var exampleCustomHttps1 = new Azure.FrontDoor.CustomHttpsConfiguration("example_custom_https_1", new()
    {
        FrontendEndpointId = exampleFrontdoor.FrontendEndpointsMap.Apply(frontendEndpointsMap => frontendEndpointsMap.ExampleFrontendEndpoint2),
        CustomHttpsProvisioningEnabled = true,
        CustomHttpsConfigurationConfig = new Azure.FrontDoor.Inputs.CustomHttpsConfigurationCustomHttpsConfigurationArgs
        {
            CertificateSource = "AzureKeyVault",
            AzureKeyVaultCertificateSecretName = "examplefd1",
            AzureKeyVaultCertificateVaultId = vault.Apply(getKeyVaultResult => getKeyVaultResult.Id),
        },
    });

});

    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.keyvault.KeyvaultFunctions;
import com.pulumi.azure.keyvault.inputs.GetKeyVaultArgs;
import com.pulumi.azure.frontdoor.Frontdoor;
import com.pulumi.azure.frontdoor.FrontdoorArgs;
import com.pulumi.azure.frontdoor.inputs.FrontdoorRoutingRuleArgs;
import com.pulumi.azure.frontdoor.inputs.FrontdoorRoutingRuleForwardingConfigurationArgs;
import com.pulumi.azure.frontdoor.inputs.FrontdoorBackendPoolLoadBalancingArgs;
import com.pulumi.azure.frontdoor.inputs.FrontdoorBackendPoolHealthProbeArgs;
import com.pulumi.azure.frontdoor.inputs.FrontdoorBackendPoolArgs;
import com.pulumi.azure.frontdoor.inputs.FrontdoorFrontendEndpointArgs;
import com.pulumi.azure.frontdoor.CustomHttpsConfiguration;
import com.pulumi.azure.frontdoor.CustomHttpsConfigurationArgs;
import com.pulumi.azure.frontdoor.inputs.CustomHttpsConfigurationCustomHttpsConfigurationArgs;
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("FrontDoorExampleResourceGroup")
            .location("West Europe")
            .build());

        final var vault = KeyvaultFunctions.getKeyVault(GetKeyVaultArgs.builder()
            .name("example-vault")
            .resourceGroupName("example-vault-rg")
            .build());

        var exampleFrontdoor = new Frontdoor("exampleFrontdoor", FrontdoorArgs.builder()
            .name("example-FrontDoor")
            .resourceGroupName(example.name())
            .routingRules(FrontdoorRoutingRuleArgs.builder()
                .name("exampleRoutingRule1")
                .acceptedProtocols(                
                    "Http",
                    "Https")
                .patternsToMatches("/*")
                .frontendEndpoints("exampleFrontendEndpoint1")
                .forwardingConfiguration(FrontdoorRoutingRuleForwardingConfigurationArgs.builder()
                    .forwardingProtocol("MatchRequest")
                    .backendPoolName("exampleBackendBing")
                    .build())
                .build())
            .backendPoolLoadBalancings(FrontdoorBackendPoolLoadBalancingArgs.builder()
                .name("exampleLoadBalancingSettings1")
                .build())
            .backendPoolHealthProbes(FrontdoorBackendPoolHealthProbeArgs.builder()
                .name("exampleHealthProbeSetting1")
                .build())
            .backendPools(FrontdoorBackendPoolArgs.builder()
                .name("exampleBackendBing")
                .backends(FrontdoorBackendPoolBackendArgs.builder()
                    .hostHeader("www.bing.com")
                    .address("www.bing.com")
                    .httpPort(80)
                    .httpsPort(443)
                    .build())
                .loadBalancingName("exampleLoadBalancingSettings1")
                .healthProbeName("exampleHealthProbeSetting1")
                .build())
            .frontendEndpoints(            
                FrontdoorFrontendEndpointArgs.builder()
                    .name("exampleFrontendEndpoint1")
                    .hostName("example-FrontDoor.azurefd.net")
                    .build(),
                FrontdoorFrontendEndpointArgs.builder()
                    .name("exampleFrontendEndpoint2")
                    .hostName("examplefd1.examplefd.net")
                    .build())
            .build());

        var exampleCustomHttps0 = new CustomHttpsConfiguration("exampleCustomHttps0", CustomHttpsConfigurationArgs.builder()
            .frontendEndpointId(exampleFrontdoor.frontendEndpointsMap().applyValue(frontendEndpointsMap -> frontendEndpointsMap.exampleFrontendEndpoint1()))
            .customHttpsProvisioningEnabled(false)
            .build());

        var exampleCustomHttps1 = new CustomHttpsConfiguration("exampleCustomHttps1", CustomHttpsConfigurationArgs.builder()
            .frontendEndpointId(exampleFrontdoor.frontendEndpointsMap().applyValue(frontendEndpointsMap -> frontendEndpointsMap.exampleFrontendEndpoint2()))
            .customHttpsProvisioningEnabled(true)
            .customHttpsConfiguration(CustomHttpsConfigurationCustomHttpsConfigurationArgs.builder()
                .certificateSource("AzureKeyVault")
                .azureKeyVaultCertificateSecretName("examplefd1")
                .azureKeyVaultCertificateVaultId(vault.applyValue(getKeyVaultResult -> getKeyVaultResult.id()))
                .build())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: FrontDoorExampleResourceGroup
      location: West Europe
  exampleFrontdoor:
    type: azure:frontdoor:Frontdoor
    name: example
    properties:
      name: example-FrontDoor
      resourceGroupName: ${example.name}
      routingRules:
        - name: exampleRoutingRule1
          acceptedProtocols:
            - Http
            - Https
          patternsToMatches:
            - /*
          frontendEndpoints:
            - exampleFrontendEndpoint1
          forwardingConfiguration:
            forwardingProtocol: MatchRequest
            backendPoolName: exampleBackendBing
      backendPoolLoadBalancings:
        - name: exampleLoadBalancingSettings1
      backendPoolHealthProbes:
        - name: exampleHealthProbeSetting1
      backendPools:
        - name: exampleBackendBing
          backends:
            - hostHeader: www.bing.com
              address: www.bing.com
              httpPort: 80
              httpsPort: 443
          loadBalancingName: exampleLoadBalancingSettings1
          healthProbeName: exampleHealthProbeSetting1
      frontendEndpoints:
        - name: exampleFrontendEndpoint1
          hostName: example-FrontDoor.azurefd.net
        - name: exampleFrontendEndpoint2
          hostName: examplefd1.examplefd.net
  exampleCustomHttps0:
    type: azure:frontdoor:CustomHttpsConfiguration
    name: example_custom_https_0
    properties:
      frontendEndpointId: ${exampleFrontdoor.frontendEndpointsMap.exampleFrontendEndpoint1}
      customHttpsProvisioningEnabled: false
  exampleCustomHttps1:
    type: azure:frontdoor:CustomHttpsConfiguration
    name: example_custom_https_1
    properties:
      frontendEndpointId: ${exampleFrontdoor.frontendEndpointsMap.exampleFrontendEndpoint2}
      customHttpsProvisioningEnabled: true
      customHttpsConfiguration:
        certificateSource: AzureKeyVault
        azureKeyVaultCertificateSecretName: examplefd1
        azureKeyVaultCertificateVaultId: ${vault.id}
variables:
  vault:
    fn::invoke:
      Function: azure:keyvault:getKeyVault
      Arguments:
        name: example-vault
        resourceGroupName: example-vault-rg

    Create CustomHttpsConfiguration Resource

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

    Constructor syntax

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

@overload
def CustomHttpsConfiguration(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             custom_https_provisioning_enabled: Optional[bool] = None,
                             frontend_endpoint_id: Optional[str] = None,
                             custom_https_configuration: Optional[CustomHttpsConfigurationCustomHttpsConfigurationArgs] = None)
    func NewCustomHttpsConfiguration(ctx *Context, name string, args CustomHttpsConfigurationArgs, opts ...ResourceOption) (*CustomHttpsConfiguration, error)
    public CustomHttpsConfiguration(string name, CustomHttpsConfigurationArgs args, CustomResourceOptions? opts = null)
    public CustomHttpsConfiguration(String name, CustomHttpsConfigurationArgs args)
public CustomHttpsConfiguration(String name, CustomHttpsConfigurationArgs args, CustomResourceOptions options)

    type: azure:frontdoor:CustomHttpsConfiguration
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 CustomHttpsConfigurationArgs
    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 CustomHttpsConfigurationArgs
    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 CustomHttpsConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomHttpsConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomHttpsConfigurationArgs
    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 customHttpsConfigurationResource = new Azure.FrontDoor.CustomHttpsConfiguration("customHttpsConfigurationResource", new()
{
    CustomHttpsProvisioningEnabled = false,
    FrontendEndpointId = "string",
    CustomHttpsConfigurationConfig = new Azure.FrontDoor.Inputs.CustomHttpsConfigurationCustomHttpsConfigurationArgs
    {
        AzureKeyVaultCertificateSecretName = "string",
        AzureKeyVaultCertificateSecretVersion = "string",
        AzureKeyVaultCertificateVaultId = "string",
        CertificateSource = "string",
        MinimumTlsVersion = "string",
        ProvisioningState = "string",
        ProvisioningSubstate = "string",
    },
});

    example, err := frontdoor.NewCustomHttpsConfiguration(ctx, "customHttpsConfigurationResource", &frontdoor.CustomHttpsConfigurationArgs{
	CustomHttpsProvisioningEnabled: pulumi.Bool(false),
	FrontendEndpointId:             pulumi.String("string"),
	CustomHttpsConfiguration: &frontdoor.CustomHttpsConfigurationCustomHttpsConfigurationArgs{
		AzureKeyVaultCertificateSecretName:    pulumi.String("string"),
		AzureKeyVaultCertificateSecretVersion: pulumi.String("string"),
		AzureKeyVaultCertificateVaultId:       pulumi.String("string"),
		CertificateSource:                     pulumi.String("string"),
		MinimumTlsVersion:                     pulumi.String("string"),
		ProvisioningState:                     pulumi.String("string"),
		ProvisioningSubstate:                  pulumi.String("string"),
	},
})

    var customHttpsConfigurationResource = new CustomHttpsConfiguration("customHttpsConfigurationResource", CustomHttpsConfigurationArgs.builder()
    .customHttpsProvisioningEnabled(false)
    .frontendEndpointId("string")
    .customHttpsConfiguration(CustomHttpsConfigurationCustomHttpsConfigurationArgs.builder()
        .azureKeyVaultCertificateSecretName("string")
        .azureKeyVaultCertificateSecretVersion("string")
        .azureKeyVaultCertificateVaultId("string")
        .certificateSource("string")
        .minimumTlsVersion("string")
        .provisioningState("string")
        .provisioningSubstate("string")
        .build())
    .build());

    custom_https_configuration_resource = azure.frontdoor.CustomHttpsConfiguration("customHttpsConfigurationResource",
    custom_https_provisioning_enabled=False,
    frontend_endpoint_id="string",
    custom_https_configuration={
        "azure_key_vault_certificate_secret_name": "string",
        "azure_key_vault_certificate_secret_version": "string",
        "azure_key_vault_certificate_vault_id": "string",
        "certificate_source": "string",
        "minimum_tls_version": "string",
        "provisioning_state": "string",
        "provisioning_substate": "string",
    })

    const customHttpsConfigurationResource = new azure.frontdoor.CustomHttpsConfiguration("customHttpsConfigurationResource", {
    customHttpsProvisioningEnabled: false,
    frontendEndpointId: "string",
    customHttpsConfiguration: {
        azureKeyVaultCertificateSecretName: "string",
        azureKeyVaultCertificateSecretVersion: "string",
        azureKeyVaultCertificateVaultId: "string",
        certificateSource: "string",
        minimumTlsVersion: "string",
        provisioningState: "string",
        provisioningSubstate: "string",
    },
});

    type: azure:frontdoor:CustomHttpsConfiguration
properties:
    customHttpsConfiguration:
        azureKeyVaultCertificateSecretName: string
        azureKeyVaultCertificateSecretVersion: string
        azureKeyVaultCertificateVaultId: string
        certificateSource: string
        minimumTlsVersion: string
        provisioningState: string
        provisioningSubstate: string
    customHttpsProvisioningEnabled: false
    frontendEndpointId: string

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

    CustomHttpsProvisioningEnabled bool
    Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
    FrontendEndpointId string
    The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
    CustomHttpsConfigurationConfig CustomHttpsConfigurationCustomHttpsConfiguration
    A custom_https_configuration block as defined above.
    CustomHttpsProvisioningEnabled bool
    Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
    FrontendEndpointId string
    The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
    CustomHttpsConfiguration CustomHttpsConfigurationCustomHttpsConfigurationArgs
    A custom_https_configuration block as defined above.
    customHttpsProvisioningEnabled Boolean
    Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
    frontendEndpointId String
    The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
    customHttpsConfiguration CustomHttpsConfigurationCustomHttpsConfiguration
    A custom_https_configuration block as defined above.
    customHttpsProvisioningEnabled boolean
    Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
    frontendEndpointId string
    The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
    customHttpsConfiguration CustomHttpsConfigurationCustomHttpsConfiguration
    A custom_https_configuration block as defined above.
    custom_https_provisioning_enabled bool
    Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
    frontend_endpoint_id str
    The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
    custom_https_configuration CustomHttpsConfigurationCustomHttpsConfigurationArgs
    A custom_https_configuration block as defined above.
    customHttpsProvisioningEnabled Boolean
    Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
    frontendEndpointId String
    The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
    customHttpsConfiguration Property Map
    A custom_https_configuration block as defined above.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CustomHttpsConfiguration Resource

    Get an existing CustomHttpsConfiguration 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?: CustomHttpsConfigurationState, opts?: CustomResourceOptions): CustomHttpsConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_https_configuration: Optional[CustomHttpsConfigurationCustomHttpsConfigurationArgs] = None,
        custom_https_provisioning_enabled: Optional[bool] = None,
        frontend_endpoint_id: Optional[str] = None) -> CustomHttpsConfiguration
    func GetCustomHttpsConfiguration(ctx *Context, name string, id IDInput, state *CustomHttpsConfigurationState, opts ...ResourceOption) (*CustomHttpsConfiguration, error)
    public static CustomHttpsConfiguration Get(string name, Input<string> id, CustomHttpsConfigurationState? state, CustomResourceOptions? opts = null)
    public static CustomHttpsConfiguration get(String name, Output<String> id, CustomHttpsConfigurationState 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:
    CustomHttpsConfigurationConfig CustomHttpsConfigurationCustomHttpsConfiguration
    A custom_https_configuration block as defined above.
    CustomHttpsProvisioningEnabled bool
    Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
    FrontendEndpointId string
    The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
    CustomHttpsConfiguration CustomHttpsConfigurationCustomHttpsConfigurationArgs
    A custom_https_configuration block as defined above.
    CustomHttpsProvisioningEnabled bool
    Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
    FrontendEndpointId string
    The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
    customHttpsConfiguration CustomHttpsConfigurationCustomHttpsConfiguration
    A custom_https_configuration block as defined above.
    customHttpsProvisioningEnabled Boolean
    Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
    frontendEndpointId String
    The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
    customHttpsConfiguration CustomHttpsConfigurationCustomHttpsConfiguration
    A custom_https_configuration block as defined above.
    customHttpsProvisioningEnabled boolean
    Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
    frontendEndpointId string
    The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
    custom_https_configuration CustomHttpsConfigurationCustomHttpsConfigurationArgs
    A custom_https_configuration block as defined above.
    custom_https_provisioning_enabled bool
    Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
    frontend_endpoint_id str
    The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.
    customHttpsConfiguration Property Map
    A custom_https_configuration block as defined above.
    customHttpsProvisioningEnabled Boolean
    Should the HTTPS protocol be enabled for this custom domain associated with the Front Door?
    frontendEndpointId String
    The ID of the Front Door Frontend Endpoint which this configuration refers to. Changing this forces a new resource to be created.

    Supporting Types

    CustomHttpsConfigurationCustomHttpsConfiguration, CustomHttpsConfigurationCustomHttpsConfigurationArgs

    AzureKeyVaultCertificateSecretName string
    The name of the Key Vault secret representing the full certificate PFX.
    AzureKeyVaultCertificateSecretVersion string

    The version of the Key Vault secret representing the full certificate PFX.

    Note: In order to enable the use of your own custom HTTPS certificate you must grant Azure Front Door Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation.

    AzureKeyVaultCertificateVaultId string
    The ID of the Key Vault containing the SSL certificate.
    CertificateSource string

    Certificate source to encrypted HTTPS traffic with. Allowed values are FrontDoor or AzureKeyVault. Defaults to FrontDoor.

    The following attributes are only valid if certificate_source is set to AzureKeyVault:

    MinimumTlsVersion string
    Minimum client TLS version supported.
    ProvisioningState string
    ProvisioningSubstate string
    AzureKeyVaultCertificateSecretName string
    The name of the Key Vault secret representing the full certificate PFX.
    AzureKeyVaultCertificateSecretVersion string

    The version of the Key Vault secret representing the full certificate PFX.

    Note: In order to enable the use of your own custom HTTPS certificate you must grant Azure Front Door Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation.

    AzureKeyVaultCertificateVaultId string
    The ID of the Key Vault containing the SSL certificate.
    CertificateSource string

    Certificate source to encrypted HTTPS traffic with. Allowed values are FrontDoor or AzureKeyVault. Defaults to FrontDoor.

    The following attributes are only valid if certificate_source is set to AzureKeyVault:

    MinimumTlsVersion string
    Minimum client TLS version supported.
    ProvisioningState string
    ProvisioningSubstate string
    azureKeyVaultCertificateSecretName String
    The name of the Key Vault secret representing the full certificate PFX.
    azureKeyVaultCertificateSecretVersion String

    The version of the Key Vault secret representing the full certificate PFX.

    Note: In order to enable the use of your own custom HTTPS certificate you must grant Azure Front Door Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation.

    azureKeyVaultCertificateVaultId String
    The ID of the Key Vault containing the SSL certificate.
    certificateSource String

    Certificate source to encrypted HTTPS traffic with. Allowed values are FrontDoor or AzureKeyVault. Defaults to FrontDoor.

    The following attributes are only valid if certificate_source is set to AzureKeyVault:

    minimumTlsVersion String
    Minimum client TLS version supported.
    provisioningState String
    provisioningSubstate String
    azureKeyVaultCertificateSecretName string
    The name of the Key Vault secret representing the full certificate PFX.
    azureKeyVaultCertificateSecretVersion string

    The version of the Key Vault secret representing the full certificate PFX.

    Note: In order to enable the use of your own custom HTTPS certificate you must grant Azure Front Door Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation.

    azureKeyVaultCertificateVaultId string
    The ID of the Key Vault containing the SSL certificate.
    certificateSource string

    Certificate source to encrypted HTTPS traffic with. Allowed values are FrontDoor or AzureKeyVault. Defaults to FrontDoor.

    The following attributes are only valid if certificate_source is set to AzureKeyVault:

    minimumTlsVersion string
    Minimum client TLS version supported.
    provisioningState string
    provisioningSubstate string
    azure_key_vault_certificate_secret_name str
    The name of the Key Vault secret representing the full certificate PFX.
    azure_key_vault_certificate_secret_version str

    The version of the Key Vault secret representing the full certificate PFX.

    Note: In order to enable the use of your own custom HTTPS certificate you must grant Azure Front Door Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation.

    azure_key_vault_certificate_vault_id str
    The ID of the Key Vault containing the SSL certificate.
    certificate_source str

    Certificate source to encrypted HTTPS traffic with. Allowed values are FrontDoor or AzureKeyVault. Defaults to FrontDoor.

    The following attributes are only valid if certificate_source is set to AzureKeyVault:

    minimum_tls_version str
    Minimum client TLS version supported.
    provisioning_state str
    provisioning_substate str
    azureKeyVaultCertificateSecretName String
    The name of the Key Vault secret representing the full certificate PFX.
    azureKeyVaultCertificateSecretVersion String

    The version of the Key Vault secret representing the full certificate PFX.

    Note: In order to enable the use of your own custom HTTPS certificate you must grant Azure Front Door Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation.

    azureKeyVaultCertificateVaultId String
    The ID of the Key Vault containing the SSL certificate.
    certificateSource String

    Certificate source to encrypted HTTPS traffic with. Allowed values are FrontDoor or AzureKeyVault. Defaults to FrontDoor.

    The following attributes are only valid if certificate_source is set to AzureKeyVault:

    minimumTlsVersion String
    Minimum client TLS version supported.
    provisioningState String
    provisioningSubstate String

    Import

    Front Door Custom HTTPS Configurations can be imported using the resource id of the Front Door Custom HTTPS Configuration, e.g.

    $ pulumi import azure:frontdoor/customHttpsConfiguration:CustomHttpsConfiguration example_custom_https_1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/frontDoors/frontdoor1/customHttpsConfiguration/endpoint1

    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 v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure