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

We recommend using Azure Native.

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

azure.network.TrafficManagerExternalEndpoint

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

    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",
});

    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")

    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
	})
}

    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",
    });

});

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

    }
}

    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

    Create TrafficManagerExternalEndpoint Resource

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

    Constructor syntax

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

@overload
def TrafficManagerExternalEndpoint(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   profile_id: Optional[str] = None,
                                   target: Optional[str] = None,
                                   always_serve_enabled: Optional[bool] = None,
                                   custom_headers: Optional[Sequence[TrafficManagerExternalEndpointCustomHeaderArgs]] = None,
                                   enabled: Optional[bool] = None,
                                   endpoint_location: Optional[str] = None,
                                   geo_mappings: Optional[Sequence[str]] = None,
                                   name: Optional[str] = None,
                                   priority: Optional[int] = None,
                                   subnets: Optional[Sequence[TrafficManagerExternalEndpointSubnetArgs]] = None,
                                   weight: Optional[int] = None)
    func NewTrafficManagerExternalEndpoint(ctx *Context, name string, args TrafficManagerExternalEndpointArgs, opts ...ResourceOption) (*TrafficManagerExternalEndpoint, error)
    public TrafficManagerExternalEndpoint(string name, TrafficManagerExternalEndpointArgs args, CustomResourceOptions? opts = null)
    public TrafficManagerExternalEndpoint(String name, TrafficManagerExternalEndpointArgs args)
public TrafficManagerExternalEndpoint(String name, TrafficManagerExternalEndpointArgs args, CustomResourceOptions options)

    type: azure:network:TrafficManagerExternalEndpoint
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 TrafficManagerExternalEndpointArgs
    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 TrafficManagerExternalEndpointArgs
    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 TrafficManagerExternalEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TrafficManagerExternalEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TrafficManagerExternalEndpointArgs
    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 trafficManagerExternalEndpointResource = new Azure.Network.TrafficManagerExternalEndpoint("trafficManagerExternalEndpointResource", new()
{
    ProfileId = "string",
    Target = "string",
    AlwaysServeEnabled = false,
    CustomHeaders = new[]
    {
        new Azure.Network.Inputs.TrafficManagerExternalEndpointCustomHeaderArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    Enabled = false,
    EndpointLocation = "string",
    GeoMappings = new[]
    {
        "string",
    },
    Name = "string",
    Priority = 0,
    Subnets = new[]
    {
        new Azure.Network.Inputs.TrafficManagerExternalEndpointSubnetArgs
        {
            First = "string",
            Last = "string",
            Scope = 0,
        },
    },
    Weight = 0,
});

    example, err := network.NewTrafficManagerExternalEndpoint(ctx, "trafficManagerExternalEndpointResource", &network.TrafficManagerExternalEndpointArgs{
	ProfileId:          pulumi.String("string"),
	Target:             pulumi.String("string"),
	AlwaysServeEnabled: pulumi.Bool(false),
	CustomHeaders: network.TrafficManagerExternalEndpointCustomHeaderArray{
		&network.TrafficManagerExternalEndpointCustomHeaderArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Enabled:          pulumi.Bool(false),
	EndpointLocation: pulumi.String("string"),
	GeoMappings: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:     pulumi.String("string"),
	Priority: pulumi.Int(0),
	Subnets: network.TrafficManagerExternalEndpointSubnetArray{
		&network.TrafficManagerExternalEndpointSubnetArgs{
			First: pulumi.String("string"),
			Last:  pulumi.String("string"),
			Scope: pulumi.Int(0),
		},
	},
	Weight: pulumi.Int(0),
})

    var trafficManagerExternalEndpointResource = new TrafficManagerExternalEndpoint("trafficManagerExternalEndpointResource", TrafficManagerExternalEndpointArgs.builder()
    .profileId("string")
    .target("string")
    .alwaysServeEnabled(false)
    .customHeaders(TrafficManagerExternalEndpointCustomHeaderArgs.builder()
        .name("string")
        .value("string")
        .build())
    .enabled(false)
    .endpointLocation("string")
    .geoMappings("string")
    .name("string")
    .priority(0)
    .subnets(TrafficManagerExternalEndpointSubnetArgs.builder()
        .first("string")
        .last("string")
        .scope(0)
        .build())
    .weight(0)
    .build());

    traffic_manager_external_endpoint_resource = azure.network.TrafficManagerExternalEndpoint("trafficManagerExternalEndpointResource",
    profile_id="string",
    target="string",
    always_serve_enabled=False,
    custom_headers=[{
        "name": "string",
        "value": "string",
    }],
    enabled=False,
    endpoint_location="string",
    geo_mappings=["string"],
    name="string",
    priority=0,
    subnets=[{
        "first": "string",
        "last": "string",
        "scope": 0,
    }],
    weight=0)

    const trafficManagerExternalEndpointResource = new azure.network.TrafficManagerExternalEndpoint("trafficManagerExternalEndpointResource", {
    profileId: "string",
    target: "string",
    alwaysServeEnabled: false,
    customHeaders: [{
        name: "string",
        value: "string",
    }],
    enabled: false,
    endpointLocation: "string",
    geoMappings: ["string"],
    name: "string",
    priority: 0,
    subnets: [{
        first: "string",
        last: "string",
        scope: 0,
    }],
    weight: 0,
});

    type: azure:network:TrafficManagerExternalEndpoint
properties:
    alwaysServeEnabled: false
    customHeaders:
        - name: string
          value: string
    enabled: false
    endpointLocation: string
    geoMappings:
        - string
    name: string
    priority: 0
    profileId: string
    subnets:
        - first: string
          last: string
          scope: 0
    target: string
    weight: 0

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

    ProfileId string
    The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.
    Target string
    The FQDN DNS name of the target.
    AlwaysServeEnabled bool
    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.
    CustomHeaders List<TrafficManagerExternalEndpointCustomHeader>
    One or more custom_header blocks as defined below.
    Enabled bool
    Is the endpoint enabled? Defaults to true.
    EndpointLocation string
    Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method.
    GeoMappings List<string>
    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.
    Name string
    The name of the External Endpoint. Changing this forces a new resource to be created.
    Priority int
    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.
    Subnets List<TrafficManagerExternalEndpointSubnet>
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    Weight int
    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.
    ProfileId string
    The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.
    Target string
    The FQDN DNS name of the target.
    AlwaysServeEnabled bool
    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.
    CustomHeaders []TrafficManagerExternalEndpointCustomHeaderArgs
    One or more custom_header blocks as defined below.
    Enabled bool
    Is the endpoint enabled? Defaults to true.
    EndpointLocation string
    Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method.
    GeoMappings []string
    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.
    Name string
    The name of the External Endpoint. Changing this forces a new resource to be created.
    Priority int
    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.
    Subnets []TrafficManagerExternalEndpointSubnetArgs
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    Weight int
    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.
    profileId String
    The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.
    target String
    The FQDN DNS name of the target.
    alwaysServeEnabled Boolean
    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.
    customHeaders List<TrafficManagerExternalEndpointCustomHeader>
    One or more custom_header blocks as defined below.
    enabled Boolean
    Is the endpoint enabled? Defaults to true.
    endpointLocation String
    Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method.
    geoMappings List<String>
    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.
    name String
    The name of the External Endpoint. Changing this forces a new resource to be created.
    priority Integer
    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.
    subnets List<TrafficManagerExternalEndpointSubnet>
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    weight Integer
    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.
    profileId string
    The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.
    target string
    The FQDN DNS name of the target.
    alwaysServeEnabled boolean
    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.
    customHeaders TrafficManagerExternalEndpointCustomHeader[]
    One or more custom_header blocks as defined below.
    enabled boolean
    Is the endpoint enabled? Defaults to true.
    endpointLocation string
    Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method.
    geoMappings string[]
    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.
    name string
    The name of the External Endpoint. Changing this forces a new resource to be created.
    priority number
    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.
    subnets TrafficManagerExternalEndpointSubnet[]
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    weight number
    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.
    profile_id str
    The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.
    target str
    The FQDN DNS name of the target.
    always_serve_enabled bool
    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.
    custom_headers Sequence[TrafficManagerExternalEndpointCustomHeaderArgs]
    One or more custom_header blocks as defined below.
    enabled bool
    Is the endpoint enabled? Defaults to true.
    endpoint_location str
    Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method.
    geo_mappings Sequence[str]
    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.
    name str
    The name of the External Endpoint. Changing this forces a new resource to be created.
    priority int
    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.
    subnets Sequence[TrafficManagerExternalEndpointSubnetArgs]
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    weight int
    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.
    profileId String
    The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.
    target String
    The FQDN DNS name of the target.
    alwaysServeEnabled Boolean
    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.
    customHeaders List<Property Map>
    One or more custom_header blocks as defined below.
    enabled Boolean
    Is the endpoint enabled? Defaults to true.
    endpointLocation String
    Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method.
    geoMappings List<String>
    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.
    name String
    The name of the External Endpoint. Changing this forces a new resource to be created.
    priority Number
    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.
    subnets List<Property Map>
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    weight Number
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TrafficManagerExternalEndpoint 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 TrafficManagerExternalEndpoint Resource

    Get an existing TrafficManagerExternalEndpoint 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?: TrafficManagerExternalEndpointState, opts?: CustomResourceOptions): TrafficManagerExternalEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        always_serve_enabled: Optional[bool] = None,
        custom_headers: Optional[Sequence[TrafficManagerExternalEndpointCustomHeaderArgs]] = None,
        enabled: Optional[bool] = None,
        endpoint_location: Optional[str] = None,
        geo_mappings: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        priority: Optional[int] = None,
        profile_id: Optional[str] = None,
        subnets: Optional[Sequence[TrafficManagerExternalEndpointSubnetArgs]] = None,
        target: Optional[str] = None,
        weight: Optional[int] = None) -> TrafficManagerExternalEndpoint
    func GetTrafficManagerExternalEndpoint(ctx *Context, name string, id IDInput, state *TrafficManagerExternalEndpointState, opts ...ResourceOption) (*TrafficManagerExternalEndpoint, error)
    public static TrafficManagerExternalEndpoint Get(string name, Input<string> id, TrafficManagerExternalEndpointState? state, CustomResourceOptions? opts = null)
    public static TrafficManagerExternalEndpoint get(String name, Output<String> id, TrafficManagerExternalEndpointState 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:
    AlwaysServeEnabled bool
    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.
    CustomHeaders List<TrafficManagerExternalEndpointCustomHeader>
    One or more custom_header blocks as defined below.
    Enabled bool
    Is the endpoint enabled? Defaults to true.
    EndpointLocation string
    Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method.
    GeoMappings List<string>
    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.
    Name string
    The name of the External Endpoint. Changing this forces a new resource to be created.
    Priority int
    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.
    ProfileId string
    The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.
    Subnets List<TrafficManagerExternalEndpointSubnet>
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    Target string
    The FQDN DNS name of the target.
    Weight int
    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.
    AlwaysServeEnabled bool
    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.
    CustomHeaders []TrafficManagerExternalEndpointCustomHeaderArgs
    One or more custom_header blocks as defined below.
    Enabled bool
    Is the endpoint enabled? Defaults to true.
    EndpointLocation string
    Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method.
    GeoMappings []string
    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.
    Name string
    The name of the External Endpoint. Changing this forces a new resource to be created.
    Priority int
    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.
    ProfileId string
    The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.
    Subnets []TrafficManagerExternalEndpointSubnetArgs
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    Target string
    The FQDN DNS name of the target.
    Weight int
    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.
    alwaysServeEnabled Boolean
    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.
    customHeaders List<TrafficManagerExternalEndpointCustomHeader>
    One or more custom_header blocks as defined below.
    enabled Boolean
    Is the endpoint enabled? Defaults to true.
    endpointLocation String
    Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method.
    geoMappings List<String>
    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.
    name String
    The name of the External Endpoint. Changing this forces a new resource to be created.
    priority Integer
    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.
    profileId String
    The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.
    subnets List<TrafficManagerExternalEndpointSubnet>
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    target String
    The FQDN DNS name of the target.
    weight Integer
    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.
    alwaysServeEnabled boolean
    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.
    customHeaders TrafficManagerExternalEndpointCustomHeader[]
    One or more custom_header blocks as defined below.
    enabled boolean
    Is the endpoint enabled? Defaults to true.
    endpointLocation string
    Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method.
    geoMappings string[]
    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.
    name string
    The name of the External Endpoint. Changing this forces a new resource to be created.
    priority number
    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.
    profileId string
    The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.
    subnets TrafficManagerExternalEndpointSubnet[]
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    target string
    The FQDN DNS name of the target.
    weight number
    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.
    always_serve_enabled bool
    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.
    custom_headers Sequence[TrafficManagerExternalEndpointCustomHeaderArgs]
    One or more custom_header blocks as defined below.
    enabled bool
    Is the endpoint enabled? Defaults to true.
    endpoint_location str
    Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method.
    geo_mappings Sequence[str]
    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.
    name str
    The name of the External Endpoint. Changing this forces a new resource to be created.
    priority int
    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.
    profile_id str
    The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.
    subnets Sequence[TrafficManagerExternalEndpointSubnetArgs]
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    target str
    The FQDN DNS name of the target.
    weight int
    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.
    alwaysServeEnabled Boolean
    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.
    customHeaders List<Property Map>
    One or more custom_header blocks as defined below.
    enabled Boolean
    Is the endpoint enabled? Defaults to true.
    endpointLocation String
    Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method.
    geoMappings List<String>
    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.
    name String
    The name of the External Endpoint. Changing this forces a new resource to be created.
    priority Number
    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.
    profileId String
    The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.
    subnets List<Property Map>
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    target String
    The FQDN DNS name of the target.
    weight Number
    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.

    Supporting Types

    TrafficManagerExternalEndpointCustomHeader, TrafficManagerExternalEndpointCustomHeaderArgs

    Name string
    The name of the custom header.
    Value string
    The value of custom header. Applicable for HTTP and HTTPS protocol.
    Name string
    The name of the custom header.
    Value string
    The value of custom header. Applicable for HTTP and HTTPS protocol.
    name String
    The name of the custom header.
    value String
    The value of custom header. Applicable for HTTP and HTTPS protocol.
    name string
    The name of the custom header.
    value string
    The value of custom header. Applicable for HTTP and HTTPS protocol.
    name str
    The name of the custom header.
    value str
    The value of custom header. Applicable for HTTP and HTTPS protocol.
    name String
    The name of the custom header.
    value String
    The value of custom header. Applicable for HTTP and HTTPS protocol.

    TrafficManagerExternalEndpointSubnet, TrafficManagerExternalEndpointSubnetArgs

    First string
    The first IP Address in this subnet.
    Last string
    The last IP Address in this subnet.
    Scope int
    The block size (number of leading bits in the subnet mask).
    First string
    The first IP Address in this subnet.
    Last string
    The last IP Address in this subnet.
    Scope int
    The block size (number of leading bits in the subnet mask).
    first String
    The first IP Address in this subnet.
    last String
    The last IP Address in this subnet.
    scope Integer
    The block size (number of leading bits in the subnet mask).
    first string
    The first IP Address in this subnet.
    last string
    The last IP Address in this subnet.
    scope number
    The block size (number of leading bits in the subnet mask).
    first str
    The first IP Address in this subnet.
    last str
    The last IP Address in this subnet.
    scope int
    The block size (number of leading bits in the subnet mask).
    first String
    The first IP Address in this subnet.
    last String
    The last IP Address in this subnet.
    scope Number
    The block size (number of leading bits in the subnet mask).

    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

    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