pulumi-azure-kotlin/com.pulumi.azure.network.kotlin/TrafficManagerExternalEndpointArgs

TrafficManagerExternalEndpointArgs

data class TrafficManagerExternalEndpointArgs(val alwaysServeEnabled: Output<Boolean>? = null, val customHeaders: Output<List<TrafficManagerExternalEndpointCustomHeaderArgs>>? = null, val enabled: Output<Boolean>? = null, val endpointLocation: Output<String>? = null, val geoMappings: Output<List<String>>? = null, val name: Output<String>? = null, val priority: Output<Int>? = null, val profileId: Output<String>? = null, val subnets: Output<List<TrafficManagerExternalEndpointSubnetArgs>>? = null, val target: Output<String>? = null, val weight: Output<Int>? = null) : ConvertibleToJava<TrafficManagerExternalEndpointArgs>

Manages an External Endpoint within a Traffic Manager Profile.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleTrafficManagerProfile = new azure.network.TrafficManagerProfile("example", {
    name: "example-profile",
    resourceGroupName: example.name,
    trafficRoutingMethod: "Weighted",
    dnsConfig: {
        relativeName: "example-profile",
        ttl: 100,
    },
    monitorConfig: {
        protocol: "HTTP",
        port: 80,
        path: "/",
        intervalInSeconds: 30,
        timeoutInSeconds: 9,
        toleratedNumberOfFailures: 3,
    },
    tags: {
        environment: "Production",
    },
});
const exampleTrafficManagerExternalEndpoint = new azure.network.TrafficManagerExternalEndpoint("example", {
    name: "example-endpoint",
    profileId: exampleTrafficManagerProfile.id,
    alwaysServeEnabled: true,
    weight: 100,
    target: "www.example.com",
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_traffic_manager_profile = azure.network.TrafficManagerProfile("example",
    name="example-profile",
    resource_group_name=example.name,
    traffic_routing_method="Weighted",
    dns_config={
        "relative_name": "example-profile",
        "ttl": 100,
    },
    monitor_config={
        "protocol": "HTTP",
        "port": 80,
        "path": "/",
        "interval_in_seconds": 30,
        "timeout_in_seconds": 9,
        "tolerated_number_of_failures": 3,
    },
    tags={
        "environment": "Production",
    })
example_traffic_manager_external_endpoint = azure.network.TrafficManagerExternalEndpoint("example",
    name="example-endpoint",
    profile_id=example_traffic_manager_profile.id,
    always_serve_enabled=True,
    weight=100,
    target="www.example.com")
Content copied to clipboard
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-resources",
        Location = "West Europe",
    });
    var exampleTrafficManagerProfile = new Azure.Network.TrafficManagerProfile("example", new()
    {
        Name = "example-profile",
        ResourceGroupName = example.Name,
        TrafficRoutingMethod = "Weighted",
        DnsConfig = new Azure.Network.Inputs.TrafficManagerProfileDnsConfigArgs
        {
            RelativeName = "example-profile",
            Ttl = 100,
        },
        MonitorConfig = new Azure.Network.Inputs.TrafficManagerProfileMonitorConfigArgs
        {
            Protocol = "HTTP",
            Port = 80,
            Path = "/",
            IntervalInSeconds = 30,
            TimeoutInSeconds = 9,
            ToleratedNumberOfFailures = 3,
        },
        Tags =
        {
            { "environment", "Production" },
        },
    });
    var exampleTrafficManagerExternalEndpoint = new Azure.Network.TrafficManagerExternalEndpoint("example", new()
    {
        Name = "example-endpoint",
        ProfileId = exampleTrafficManagerProfile.Id,
        AlwaysServeEnabled = true,
        Weight = 100,
        Target = "www.example.com",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"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-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleTrafficManagerProfile, err := network.NewTrafficManagerProfile(ctx, "example", &network.TrafficManagerProfileArgs{
			Name:                 pulumi.String("example-profile"),
			ResourceGroupName:    example.Name,
			TrafficRoutingMethod: pulumi.String("Weighted"),
			DnsConfig: &network.TrafficManagerProfileDnsConfigArgs{
				RelativeName: pulumi.String("example-profile"),
				Ttl:          pulumi.Int(100),
			},
			MonitorConfig: &network.TrafficManagerProfileMonitorConfigArgs{
				Protocol:                  pulumi.String("HTTP"),
				Port:                      pulumi.Int(80),
				Path:                      pulumi.String("/"),
				IntervalInSeconds:         pulumi.Int(30),
				TimeoutInSeconds:          pulumi.Int(9),
				ToleratedNumberOfFailures: pulumi.Int(3),
			},
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		_, err = network.NewTrafficManagerExternalEndpoint(ctx, "example", &network.TrafficManagerExternalEndpointArgs{
			Name:               pulumi.String("example-endpoint"),
			ProfileId:          exampleTrafficManagerProfile.ID(),
			AlwaysServeEnabled: pulumi.Bool(true),
			Weight:             pulumi.Int(100),
			Target:             pulumi.String("www.example.com"),
		})
		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.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.TrafficManagerProfile;
import com.pulumi.azure.network.TrafficManagerProfileArgs;
import com.pulumi.azure.network.inputs.TrafficManagerProfileDnsConfigArgs;
import com.pulumi.azure.network.inputs.TrafficManagerProfileMonitorConfigArgs;
import com.pulumi.azure.network.TrafficManagerExternalEndpoint;
import com.pulumi.azure.network.TrafficManagerExternalEndpointArgs;
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-resources")
            .location("West Europe")
            .build());
        var exampleTrafficManagerProfile = new TrafficManagerProfile("exampleTrafficManagerProfile", TrafficManagerProfileArgs.builder()
            .name("example-profile")
            .resourceGroupName(example.name())
            .trafficRoutingMethod("Weighted")
            .dnsConfig(TrafficManagerProfileDnsConfigArgs.builder()
                .relativeName("example-profile")
                .ttl(100)
                .build())
            .monitorConfig(TrafficManagerProfileMonitorConfigArgs.builder()
                .protocol("HTTP")
                .port(80)
                .path("/")
                .intervalInSeconds(30)
                .timeoutInSeconds(9)
                .toleratedNumberOfFailures(3)
                .build())
            .tags(Map.of("environment", "Production"))
            .build());
        var exampleTrafficManagerExternalEndpoint = new TrafficManagerExternalEndpoint("exampleTrafficManagerExternalEndpoint", TrafficManagerExternalEndpointArgs.builder()
            .name("example-endpoint")
            .profileId(exampleTrafficManagerProfile.id())
            .alwaysServeEnabled(true)
            .weight(100)
            .target("www.example.com")
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleTrafficManagerProfile:
    type: azure:network:TrafficManagerProfile
    name: example
    properties:
      name: example-profile
      resourceGroupName: ${example.name}
      trafficRoutingMethod: Weighted
      dnsConfig:
        relativeName: example-profile
        ttl: 100
      monitorConfig:
        protocol: HTTP
        port: 80
        path: /
        intervalInSeconds: 30
        timeoutInSeconds: 9
        toleratedNumberOfFailures: 3
      tags:
        environment: Production
  exampleTrafficManagerExternalEndpoint:
    type: azure:network:TrafficManagerExternalEndpoint
    name: example
    properties:
      name: example-endpoint
      profileId: ${exampleTrafficManagerProfile.id}
      alwaysServeEnabled: true
      weight: 100
      target: www.example.com
Content copied to clipboard

API Providers

This resource uses the following Azure API Providers:

  • Microsoft.Network: 2022-04-01

Import

External Endpoints can be imported using the resource id, e.g.

$ pulumi import azure:network/trafficManagerExternalEndpoint:TrafficManagerExternalEndpoint example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-group/providers/Microsoft.Network/trafficManagerProfiles/example-profile/ExternalEndpoints/example-endpoint
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(alwaysServeEnabled: Output<Boolean>? = null, customHeaders: Output<List<TrafficManagerExternalEndpointCustomHeaderArgs>>? = null, enabled: Output<Boolean>? = null, endpointLocation: Output<String>? = null, geoMappings: Output<List<String>>? = null, name: Output<String>? = null, priority: Output<Int>? = null, profileId: Output<String>? = null, subnets: Output<List<TrafficManagerExternalEndpointSubnetArgs>>? = null, target: Output<String>? = null, weight: Output<Int>? = null)

Properties

Link copied to clipboard
val alwaysServeEnabled: Output<Boolean>? = null

If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. Defaults to false.

Link copied to clipboard
val customHeaders: Output<List<TrafficManagerExternalEndpointCustomHeaderArgs>>? = null

One or more custom_header blocks as defined below.

Link copied to clipboard
val enabled: Output<Boolean>? = null

Is the endpoint enabled? Defaults to true.

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

Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method.

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

A list of Geographic Regions used to distribute traffic, such as WORLD, UK or DE. The same location can't be specified in two endpoints. See the Geographic Hierarchies documentation for more information.

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

The name of the External Endpoint. Changing this forces a new resource to be created.

Link copied to clipboard
val priority: Output<Int>? = null

Specifies the priority of this Endpoint, this must be specified for Profiles using the Priority traffic routing method. Supports values between 1 and 1000, with no Endpoints sharing the same value. If omitted the value will be computed in order of creation.

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

The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.

Link copied to clipboard
val subnets: Output<List<TrafficManagerExternalEndpointSubnetArgs>>? = null

One or more subnet blocks as defined below. Changing this forces a new resource to be created.

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

The FQDN DNS name of the target.

Link copied to clipboard
val weight: Output<Int>? = null

Specifies how much traffic should be distributed to this endpoint, this must be specified for Profiles using the Weighted traffic routing method. Valid values are between 1 and 1000. Defaults to 1.

Functions

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