pulumi-azure-native-kotlin/com.pulumi.azurenative.frontdoor.kotlin/FrontDoorArgs

FrontDoorArgs

data class FrontDoorArgs(val backendPools: Output<List<BackendPoolArgs>>? = null, val backendPoolsSettings: Output<BackendPoolsSettingsArgs>? = null, val enabledState: Output<Either<String, FrontDoorEnabledState>>? = null, val friendlyName: Output<String>? = null, val frontDoorName: Output<String>? = null, val frontendEndpoints: Output<List<FrontendEndpointArgs>>? = null, val healthProbeSettings: Output<List<HealthProbeSettingsModelArgs>>? = null, val loadBalancingSettings: Output<List<LoadBalancingSettingsModelArgs>>? = null, val location: Output<String>? = null, val resourceGroupName: Output<String>? = null, val routingRules: Output<List<RoutingRuleArgs>>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<FrontDoorArgs>

Front Door represents a collection of backend endpoints to route traffic to along with rules that specify how traffic is sent there. Uses Azure REST API version 2021-06-01. Other available API versions: 2019-04-01, 2019-05-01, 2020-01-01, 2020-04-01, 2020-05-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native frontdoor [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Create or update specific Front Door

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var frontDoor = new AzureNative.FrontDoor.FrontDoor("frontDoor", new()
    {
        BackendPools = new[]
        {
            new AzureNative.FrontDoor.Inputs.BackendPoolArgs
            {
                Backends = new[]
                {
                    new AzureNative.FrontDoor.Inputs.BackendArgs
                    {
                        Address = "w3.contoso.com",
                        HttpPort = 80,
                        HttpsPort = 443,
                        Priority = 2,
                        Weight = 1,
                    },
                    new AzureNative.FrontDoor.Inputs.BackendArgs
                    {
                        Address = "contoso.com.website-us-west-2.othercloud.net",
                        HttpPort = 80,
                        HttpsPort = 443,
                        Priority = 1,
                        PrivateLinkApprovalMessage = "Please approve the connection request for this Private Link",
                        PrivateLinkLocation = "eastus",
                        PrivateLinkResourceId = "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1",
                        Weight = 2,
                    },
                    new AzureNative.FrontDoor.Inputs.BackendArgs
                    {
                        Address = "10.0.1.5",
                        HttpPort = 80,
                        HttpsPort = 443,
                        Priority = 1,
                        PrivateLinkAlias = "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice",
                        PrivateLinkApprovalMessage = "Please approve this request to connect to the Private Link",
                        Weight = 1,
                    },
                },
                HealthProbeSettings = new AzureNative.FrontDoor.Inputs.SubResourceArgs
                {
                    Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1",
                },
                LoadBalancingSettings = new AzureNative.FrontDoor.Inputs.SubResourceArgs
                {
                    Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1",
                },
                Name = "backendPool1",
            },
        },
        BackendPoolsSettings = new AzureNative.FrontDoor.Inputs.BackendPoolsSettingsArgs
        {
            EnforceCertificateNameCheck = AzureNative.FrontDoor.EnforceCertificateNameCheckEnabledState.Enabled,
            SendRecvTimeoutSeconds = 60,
        },
        EnabledState = AzureNative.FrontDoor.FrontDoorEnabledState.Enabled,
        FrontDoorName = "frontDoor1",
        FrontendEndpoints = new[]
        {
            new AzureNative.FrontDoor.Inputs.FrontendEndpointArgs
            {
                HostName = "www.contoso.com",
                Name = "frontendEndpoint1",
                SessionAffinityEnabledState = AzureNative.FrontDoor.SessionAffinityEnabledState.Enabled,
                SessionAffinityTtlSeconds = 60,
                WebApplicationFirewallPolicyLink = new AzureNative.FrontDoor.Inputs.FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLinkArgs
                {
                    Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1",
                },
            },
            new AzureNative.FrontDoor.Inputs.FrontendEndpointArgs
            {
                HostName = "frontDoor1.azurefd.net",
                Name = "default",
            },
        },
        HealthProbeSettings = new[]
        {
            new AzureNative.FrontDoor.Inputs.HealthProbeSettingsModelArgs
            {
                EnabledState = AzureNative.FrontDoor.HealthProbeEnabled.Enabled,
                HealthProbeMethod = AzureNative.FrontDoor.FrontDoorHealthProbeMethod.HEAD,
                IntervalInSeconds = 120,
                Name = "healthProbeSettings1",
                Path = "/",
                Protocol = AzureNative.FrontDoor.FrontDoorProtocol.Http,
            },
        },
        LoadBalancingSettings = new[]
        {
            new AzureNative.FrontDoor.Inputs.LoadBalancingSettingsModelArgs
            {
                Name = "loadBalancingSettings1",
                SampleSize = 4,
                SuccessfulSamplesRequired = 2,
            },
        },
        Location = "westus",
        ResourceGroupName = "rg1",
        RoutingRules = new[]
        {
            new AzureNative.FrontDoor.Inputs.RoutingRuleArgs
            {
                AcceptedProtocols = new[]
                {
                    AzureNative.FrontDoor.FrontDoorProtocol.Http,
                },
                EnabledState = AzureNative.FrontDoor.RoutingRuleEnabledState.Enabled,
                FrontendEndpoints = new[]
                {
                    new AzureNative.FrontDoor.Inputs.SubResourceArgs
                    {
                        Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1",
                    },
                    new AzureNative.FrontDoor.Inputs.SubResourceArgs
                    {
                        Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default",
                    },
                },
                Name = "routingRule1",
                PatternsToMatch = new[]
                {
                    "/*",
                },
                RouteConfiguration = new AzureNative.FrontDoor.Inputs.ForwardingConfigurationArgs
                {
                    BackendPool = new AzureNative.FrontDoor.Inputs.SubResourceArgs
                    {
                        Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1",
                    },
                    OdataType = "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
                },
                RulesEngine = new AzureNative.FrontDoor.Inputs.SubResourceArgs
                {
                    Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1",
                },
                WebApplicationFirewallPolicyLink = new AzureNative.FrontDoor.Inputs.RoutingRuleUpdateParametersWebApplicationFirewallPolicyLinkArgs
                {
                    Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1",
                },
            },
        },
        Tags =
        {
            { "tag1", "value1" },
            { "tag2", "value2" },
        },
    });
});
Content copied to clipboard
package main
import (
	frontdoor "github.com/pulumi/pulumi-azure-native-sdk/frontdoor/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := frontdoor.NewFrontDoor(ctx, "frontDoor", &frontdoor.FrontDoorArgs{
			BackendPools: frontdoor.BackendPoolArray{
				&frontdoor.BackendPoolArgs{
					Backends: frontdoor.BackendArray{
						&frontdoor.BackendArgs{
							Address:   pulumi.String("w3.contoso.com"),
							HttpPort:  pulumi.Int(80),
							HttpsPort: pulumi.Int(443),
							Priority:  pulumi.Int(2),
							Weight:    pulumi.Int(1),
						},
						&frontdoor.BackendArgs{
							Address:                    pulumi.String("contoso.com.website-us-west-2.othercloud.net"),
							HttpPort:                   pulumi.Int(80),
							HttpsPort:                  pulumi.Int(443),
							Priority:                   pulumi.Int(1),
							PrivateLinkApprovalMessage: pulumi.String("Please approve the connection request for this Private Link"),
							PrivateLinkLocation:        pulumi.String("eastus"),
							PrivateLinkResourceId:      pulumi.String("/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1"),
							Weight:                     pulumi.Int(2),
						},
						&frontdoor.BackendArgs{
							Address:                    pulumi.String("10.0.1.5"),
							HttpPort:                   pulumi.Int(80),
							HttpsPort:                  pulumi.Int(443),
							Priority:                   pulumi.Int(1),
							PrivateLinkAlias:           pulumi.String("APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice"),
							PrivateLinkApprovalMessage: pulumi.String("Please approve this request to connect to the Private Link"),
							Weight:                     pulumi.Int(1),
						},
					},
					HealthProbeSettings: &frontdoor.SubResourceArgs{
						Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1"),
					},
					LoadBalancingSettings: &frontdoor.SubResourceArgs{
						Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1"),
					},
					Name: pulumi.String("backendPool1"),
				},
			},
			BackendPoolsSettings: &frontdoor.BackendPoolsSettingsArgs{
				EnforceCertificateNameCheck: pulumi.String(frontdoor.EnforceCertificateNameCheckEnabledStateEnabled),
				SendRecvTimeoutSeconds:      pulumi.Int(60),
			},
			EnabledState:  pulumi.String(frontdoor.FrontDoorEnabledStateEnabled),
			FrontDoorName: pulumi.String("frontDoor1"),
			FrontendEndpoints: frontdoor.FrontendEndpointArray{
				&frontdoor.FrontendEndpointArgs{
					HostName:                    pulumi.String("www.contoso.com"),
					Name:                        pulumi.String("frontendEndpoint1"),
					SessionAffinityEnabledState: pulumi.String(frontdoor.SessionAffinityEnabledStateEnabled),
					SessionAffinityTtlSeconds:   pulumi.Int(60),
					WebApplicationFirewallPolicyLink: &frontdoor.FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLinkArgs{
						Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1"),
					},
				},
				&frontdoor.FrontendEndpointArgs{
					HostName: pulumi.String("frontDoor1.azurefd.net"),
					Name:     pulumi.String("default"),
				},
			},
			HealthProbeSettings: frontdoor.HealthProbeSettingsModelArray{
				&frontdoor.HealthProbeSettingsModelArgs{
					EnabledState:      pulumi.String(frontdoor.HealthProbeEnabledEnabled),
					HealthProbeMethod: pulumi.String(frontdoor.FrontDoorHealthProbeMethodHEAD),
					IntervalInSeconds: pulumi.Int(120),
					Name:              pulumi.String("healthProbeSettings1"),
					Path:              pulumi.String("/"),
					Protocol:          pulumi.String(frontdoor.FrontDoorProtocolHttp),
				},
			},
			LoadBalancingSettings: frontdoor.LoadBalancingSettingsModelArray{
				&frontdoor.LoadBalancingSettingsModelArgs{
					Name:                      pulumi.String("loadBalancingSettings1"),
					SampleSize:                pulumi.Int(4),
					SuccessfulSamplesRequired: pulumi.Int(2),
				},
			},
			Location:          pulumi.String("westus"),
			ResourceGroupName: pulumi.String("rg1"),
			RoutingRules: frontdoor.RoutingRuleArray{
				&frontdoor.RoutingRuleArgs{
					AcceptedProtocols: pulumi.StringArray{
						pulumi.String(frontdoor.FrontDoorProtocolHttp),
					},
					EnabledState: pulumi.String(frontdoor.RoutingRuleEnabledStateEnabled),
					FrontendEndpoints: frontdoor.SubResourceArray{
						&frontdoor.SubResourceArgs{
							Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1"),
						},
						&frontdoor.SubResourceArgs{
							Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default"),
						},
					},
					Name: pulumi.String("routingRule1"),
					PatternsToMatch: pulumi.StringArray{
						pulumi.String("/*"),
					},
					RouteConfiguration: frontdoor.ForwardingConfiguration{
						BackendPool: frontdoor.SubResource{
							Id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1",
						},
						OdataType: "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration",
					},
					RulesEngine: &frontdoor.SubResourceArgs{
						Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1"),
					},
					WebApplicationFirewallPolicyLink: &frontdoor.RoutingRuleUpdateParametersWebApplicationFirewallPolicyLinkArgs{
						Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1"),
					},
				},
			},
			Tags: pulumi.StringMap{
				"tag1": pulumi.String("value1"),
				"tag2": pulumi.String("value2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.frontdoor.FrontDoor;
import com.pulumi.azurenative.frontdoor.FrontDoorArgs;
import com.pulumi.azurenative.frontdoor.inputs.BackendPoolArgs;
import com.pulumi.azurenative.frontdoor.inputs.SubResourceArgs;
import com.pulumi.azurenative.frontdoor.inputs.BackendPoolsSettingsArgs;
import com.pulumi.azurenative.frontdoor.inputs.FrontendEndpointArgs;
import com.pulumi.azurenative.frontdoor.inputs.FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLinkArgs;
import com.pulumi.azurenative.frontdoor.inputs.HealthProbeSettingsModelArgs;
import com.pulumi.azurenative.frontdoor.inputs.LoadBalancingSettingsModelArgs;
import com.pulumi.azurenative.frontdoor.inputs.RoutingRuleArgs;
import com.pulumi.azurenative.frontdoor.inputs.RoutingRuleUpdateParametersWebApplicationFirewallPolicyLinkArgs;
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 frontDoor = new FrontDoor("frontDoor", FrontDoorArgs.builder()
            .backendPools(BackendPoolArgs.builder()
                .backends(
                    BackendArgs.builder()
                        .address("w3.contoso.com")
                        .httpPort(80)
                        .httpsPort(443)
                        .priority(2)
                        .weight(1)
                        .build(),
                    BackendArgs.builder()
                        .address("contoso.com.website-us-west-2.othercloud.net")
                        .httpPort(80)
                        .httpsPort(443)
                        .priority(1)
                        .privateLinkApprovalMessage("Please approve the connection request for this Private Link")
                        .privateLinkLocation("eastus")
                        .privateLinkResourceId("/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1")
                        .weight(2)
                        .build(),
                    BackendArgs.builder()
                        .address("10.0.1.5")
                        .httpPort(80)
                        .httpsPort(443)
                        .priority(1)
                        .privateLinkAlias("APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice")
                        .privateLinkApprovalMessage("Please approve this request to connect to the Private Link")
                        .weight(1)
                        .build())
                .healthProbeSettings(SubResourceArgs.builder()
                    .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1")
                    .build())
                .loadBalancingSettings(SubResourceArgs.builder()
                    .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1")
                    .build())
                .name("backendPool1")
                .build())
            .backendPoolsSettings(BackendPoolsSettingsArgs.builder()
                .enforceCertificateNameCheck("Enabled")
                .sendRecvTimeoutSeconds(60)
                .build())
            .enabledState("Enabled")
            .frontDoorName("frontDoor1")
            .frontendEndpoints(
                FrontendEndpointArgs.builder()
                    .hostName("www.contoso.com")
                    .name("frontendEndpoint1")
                    .sessionAffinityEnabledState("Enabled")
                    .sessionAffinityTtlSeconds(60)
                    .webApplicationFirewallPolicyLink(FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLinkArgs.builder()
                        .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1")
                        .build())
                    .build(),
                FrontendEndpointArgs.builder()
                    .hostName("frontDoor1.azurefd.net")
                    .name("default")
                    .build())
            .healthProbeSettings(HealthProbeSettingsModelArgs.builder()
                .enabledState("Enabled")
                .healthProbeMethod("HEAD")
                .intervalInSeconds(120)
                .name("healthProbeSettings1")
                .path("/")
                .protocol("Http")
                .build())
            .loadBalancingSettings(LoadBalancingSettingsModelArgs.builder()
                .name("loadBalancingSettings1")
                .sampleSize(4)
                .successfulSamplesRequired(2)
                .build())
            .location("westus")
            .resourceGroupName("rg1")
            .routingRules(RoutingRuleArgs.builder()
                .acceptedProtocols("Http")
                .enabledState("Enabled")
                .frontendEndpoints(
                    SubResourceArgs.builder()
                        .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1")
                        .build(),
                    SubResourceArgs.builder()
                        .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default")
                        .build())
                .name("routingRule1")
                .patternsToMatch("/*")
                .routeConfiguration(ForwardingConfigurationArgs.builder()
                    .backendPool(SubResourceArgs.builder()
                        .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1")
                        .build())
                    .odataType("#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration")
                    .build())
                .rulesEngine(SubResourceArgs.builder()
                    .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1")
                    .build())
                .webApplicationFirewallPolicyLink(RoutingRuleUpdateParametersWebApplicationFirewallPolicyLinkArgs.builder()
                    .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1")
                    .build())
                .build())
            .tags(Map.ofEntries(
                Map.entry("tag1", "value1"),
                Map.entry("tag2", "value2")
            ))
            .build());
    }
}
Content copied to clipboard

Import

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

$ pulumi import azure-native:frontdoor:FrontDoor frontDoor1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(backendPools: Output<List<BackendPoolArgs>>? = null, backendPoolsSettings: Output<BackendPoolsSettingsArgs>? = null, enabledState: Output<Either<String, FrontDoorEnabledState>>? = null, friendlyName: Output<String>? = null, frontDoorName: Output<String>? = null, frontendEndpoints: Output<List<FrontendEndpointArgs>>? = null, healthProbeSettings: Output<List<HealthProbeSettingsModelArgs>>? = null, loadBalancingSettings: Output<List<LoadBalancingSettingsModelArgs>>? = null, location: Output<String>? = null, resourceGroupName: Output<String>? = null, routingRules: Output<List<RoutingRuleArgs>>? = null, tags: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard
val backendPools: Output<List<BackendPoolArgs>>? = null

Backend pools available to routing rules.

Link copied to clipboard
val backendPoolsSettings: Output<BackendPoolsSettingsArgs>? = null

Settings for all backendPools

Link copied to clipboard
val enabledState: Output<Either<String, FrontDoorEnabledState>>? = null

Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'

Link copied to clipboard
val friendlyName: Output<String>? = null

A friendly name for the frontDoor

Link copied to clipboard
val frontDoorName: Output<String>? = null

Name of the Front Door which is globally unique.

Link copied to clipboard
val frontendEndpoints: Output<List<FrontendEndpointArgs>>? = null

Frontend endpoints available to routing rules.

Link copied to clipboard
val healthProbeSettings: Output<List<HealthProbeSettingsModelArgs>>? = null

Health probe settings associated with this Front Door instance.

Link copied to clipboard
val loadBalancingSettings: Output<List<LoadBalancingSettingsModelArgs>>? = null

Load balancing settings associated with this Front Door instance.

Link copied to clipboard
val location: Output<String>? = null

Resource location.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

Name of the Resource group within the Azure subscription.

Link copied to clipboard
val routingRules: Output<List<RoutingRuleArgs>>? = null

Routing rules associated with this Front Door.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Resource tags. //*/

Functions

Link copied to clipboard
open override fun toJava(): FrontDoorArgs