1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. TrafficManagerAzureEndpoint

We recommend using Azure Native.

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

azure.network.TrafficManagerAzureEndpoint

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

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

    Manages an Azure 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 examplePublicIp = new azure.network.PublicIp("example", {
        name: "example-public-ip",
        location: example.location,
        resourceGroupName: example.name,
        allocationMethod: "Static",
        domainNameLabel: "example-public-ip",
    });
    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 exampleTrafficManagerAzureEndpoint = new azure.network.TrafficManagerAzureEndpoint("example", {
        name: "example-endpoint",
        profileId: exampleTrafficManagerProfile.id,
        alwaysServeEnabled: true,
        weight: 100,
        targetResourceId: examplePublicIp.id,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_public_ip = azure.network.PublicIp("example",
        name="example-public-ip",
        location=example.location,
        resource_group_name=example.name,
        allocation_method="Static",
        domain_name_label="example-public-ip")
    example_traffic_manager_profile = azure.network.TrafficManagerProfile("example",
        name="example-profile",
        resource_group_name=example.name,
        traffic_routing_method="Weighted",
        dns_config=azure.network.TrafficManagerProfileDnsConfigArgs(
            relative_name="example-profile",
            ttl=100,
        ),
        monitor_config=azure.network.TrafficManagerProfileMonitorConfigArgs(
            protocol="HTTP",
            port=80,
            path="/",
            interval_in_seconds=30,
            timeout_in_seconds=9,
            tolerated_number_of_failures=3,
        ),
        tags={
            "environment": "Production",
        })
    example_traffic_manager_azure_endpoint = azure.network.TrafficManagerAzureEndpoint("example",
        name="example-endpoint",
        profile_id=example_traffic_manager_profile.id,
        always_serve_enabled=True,
        weight=100,
        target_resource_id=example_public_ip.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/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
    		}
    		examplePublicIp, err := network.NewPublicIp(ctx, "example", &network.PublicIpArgs{
    			Name:              pulumi.String("example-public-ip"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			AllocationMethod:  pulumi.String("Static"),
    			DomainNameLabel:   pulumi.String("example-public-ip"),
    		})
    		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.NewTrafficManagerAzureEndpoint(ctx, "example", &network.TrafficManagerAzureEndpointArgs{
    			Name:               pulumi.String("example-endpoint"),
    			ProfileId:          exampleTrafficManagerProfile.ID(),
    			AlwaysServeEnabled: pulumi.Bool(true),
    			Weight:             pulumi.Int(100),
    			TargetResourceId:   examplePublicIp.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 = "example-resources",
            Location = "West Europe",
        });
    
        var examplePublicIp = new Azure.Network.PublicIp("example", new()
        {
            Name = "example-public-ip",
            Location = example.Location,
            ResourceGroupName = example.Name,
            AllocationMethod = "Static",
            DomainNameLabel = "example-public-ip",
        });
    
        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 exampleTrafficManagerAzureEndpoint = new Azure.Network.TrafficManagerAzureEndpoint("example", new()
        {
            Name = "example-endpoint",
            ProfileId = exampleTrafficManagerProfile.Id,
            AlwaysServeEnabled = true,
            Weight = 100,
            TargetResourceId = examplePublicIp.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.network.PublicIp;
    import com.pulumi.azure.network.PublicIpArgs;
    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.TrafficManagerAzureEndpoint;
    import com.pulumi.azure.network.TrafficManagerAzureEndpointArgs;
    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 examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()
                .name("example-public-ip")
                .location(example.location())
                .resourceGroupName(example.name())
                .allocationMethod("Static")
                .domainNameLabel("example-public-ip")
                .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 exampleTrafficManagerAzureEndpoint = new TrafficManagerAzureEndpoint("exampleTrafficManagerAzureEndpoint", TrafficManagerAzureEndpointArgs.builder()
                .name("example-endpoint")
                .profileId(exampleTrafficManagerProfile.id())
                .alwaysServeEnabled(true)
                .weight(100)
                .targetResourceId(examplePublicIp.id())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      examplePublicIp:
        type: azure:network:PublicIp
        name: example
        properties:
          name: example-public-ip
          location: ${example.location}
          resourceGroupName: ${example.name}
          allocationMethod: Static
          domainNameLabel: example-public-ip
      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
      exampleTrafficManagerAzureEndpoint:
        type: azure:network:TrafficManagerAzureEndpoint
        name: example
        properties:
          name: example-endpoint
          profileId: ${exampleTrafficManagerProfile.id}
          alwaysServeEnabled: true
          weight: 100
          targetResourceId: ${examplePublicIp.id}
    

    Create TrafficManagerAzureEndpoint Resource

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

    Constructor syntax

    new TrafficManagerAzureEndpoint(name: string, args: TrafficManagerAzureEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def TrafficManagerAzureEndpoint(resource_name: str,
                                    args: TrafficManagerAzureEndpointArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def TrafficManagerAzureEndpoint(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    profile_id: Optional[str] = None,
                                    target_resource_id: Optional[str] = None,
                                    always_serve_enabled: Optional[bool] = None,
                                    custom_headers: Optional[Sequence[TrafficManagerAzureEndpointCustomHeaderArgs]] = None,
                                    enabled: Optional[bool] = None,
                                    geo_mappings: Optional[Sequence[str]] = None,
                                    name: Optional[str] = None,
                                    priority: Optional[int] = None,
                                    subnets: Optional[Sequence[TrafficManagerAzureEndpointSubnetArgs]] = None,
                                    weight: Optional[int] = None)
    func NewTrafficManagerAzureEndpoint(ctx *Context, name string, args TrafficManagerAzureEndpointArgs, opts ...ResourceOption) (*TrafficManagerAzureEndpoint, error)
    public TrafficManagerAzureEndpoint(string name, TrafficManagerAzureEndpointArgs args, CustomResourceOptions? opts = null)
    public TrafficManagerAzureEndpoint(String name, TrafficManagerAzureEndpointArgs args)
    public TrafficManagerAzureEndpoint(String name, TrafficManagerAzureEndpointArgs args, CustomResourceOptions options)
    
    type: azure:network:TrafficManagerAzureEndpoint
    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 TrafficManagerAzureEndpointArgs
    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 TrafficManagerAzureEndpointArgs
    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 TrafficManagerAzureEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TrafficManagerAzureEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TrafficManagerAzureEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var trafficManagerAzureEndpointResource = new Azure.Network.TrafficManagerAzureEndpoint("trafficManagerAzureEndpointResource", new()
    {
        ProfileId = "string",
        TargetResourceId = "string",
        AlwaysServeEnabled = false,
        CustomHeaders = new[]
        {
            new Azure.Network.Inputs.TrafficManagerAzureEndpointCustomHeaderArgs
            {
                Name = "string",
                Value = "string",
            },
        },
        Enabled = false,
        GeoMappings = new[]
        {
            "string",
        },
        Name = "string",
        Priority = 0,
        Subnets = new[]
        {
            new Azure.Network.Inputs.TrafficManagerAzureEndpointSubnetArgs
            {
                First = "string",
                Last = "string",
                Scope = 0,
            },
        },
        Weight = 0,
    });
    
    example, err := network.NewTrafficManagerAzureEndpoint(ctx, "trafficManagerAzureEndpointResource", &network.TrafficManagerAzureEndpointArgs{
    	ProfileId:          pulumi.String("string"),
    	TargetResourceId:   pulumi.String("string"),
    	AlwaysServeEnabled: pulumi.Bool(false),
    	CustomHeaders: network.TrafficManagerAzureEndpointCustomHeaderArray{
    		&network.TrafficManagerAzureEndpointCustomHeaderArgs{
    			Name:  pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	Enabled: pulumi.Bool(false),
    	GeoMappings: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name:     pulumi.String("string"),
    	Priority: pulumi.Int(0),
    	Subnets: network.TrafficManagerAzureEndpointSubnetArray{
    		&network.TrafficManagerAzureEndpointSubnetArgs{
    			First: pulumi.String("string"),
    			Last:  pulumi.String("string"),
    			Scope: pulumi.Int(0),
    		},
    	},
    	Weight: pulumi.Int(0),
    })
    
    var trafficManagerAzureEndpointResource = new TrafficManagerAzureEndpoint("trafficManagerAzureEndpointResource", TrafficManagerAzureEndpointArgs.builder()
        .profileId("string")
        .targetResourceId("string")
        .alwaysServeEnabled(false)
        .customHeaders(TrafficManagerAzureEndpointCustomHeaderArgs.builder()
            .name("string")
            .value("string")
            .build())
        .enabled(false)
        .geoMappings("string")
        .name("string")
        .priority(0)
        .subnets(TrafficManagerAzureEndpointSubnetArgs.builder()
            .first("string")
            .last("string")
            .scope(0)
            .build())
        .weight(0)
        .build());
    
    traffic_manager_azure_endpoint_resource = azure.network.TrafficManagerAzureEndpoint("trafficManagerAzureEndpointResource",
        profile_id="string",
        target_resource_id="string",
        always_serve_enabled=False,
        custom_headers=[azure.network.TrafficManagerAzureEndpointCustomHeaderArgs(
            name="string",
            value="string",
        )],
        enabled=False,
        geo_mappings=["string"],
        name="string",
        priority=0,
        subnets=[azure.network.TrafficManagerAzureEndpointSubnetArgs(
            first="string",
            last="string",
            scope=0,
        )],
        weight=0)
    
    const trafficManagerAzureEndpointResource = new azure.network.TrafficManagerAzureEndpoint("trafficManagerAzureEndpointResource", {
        profileId: "string",
        targetResourceId: "string",
        alwaysServeEnabled: false,
        customHeaders: [{
            name: "string",
            value: "string",
        }],
        enabled: false,
        geoMappings: ["string"],
        name: "string",
        priority: 0,
        subnets: [{
            first: "string",
            last: "string",
            scope: 0,
        }],
        weight: 0,
    });
    
    type: azure:network:TrafficManagerAzureEndpoint
    properties:
        alwaysServeEnabled: false
        customHeaders:
            - name: string
              value: string
        enabled: false
        geoMappings:
            - string
        name: string
        priority: 0
        profileId: string
        subnets:
            - first: string
              last: string
              scope: 0
        targetResourceId: string
        weight: 0
    

    TrafficManagerAzureEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The TrafficManagerAzureEndpoint resource accepts the following input properties:

    ProfileId string
    The ID of the Traffic Manager Profile that this Azure Endpoint should be created within. Changing this forces a new resource to be created.
    TargetResourceId string
    The ID of the Azure Resource which should be used as a 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<TrafficManagerAzureEndpointCustomHeader>
    One or more custom_header blocks as defined below.
    Enabled bool
    Is the endpoint enabled? Defaults to true.
    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 Azure 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<TrafficManagerAzureEndpointSubnet>
    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.
    ProfileId string
    The ID of the Traffic Manager Profile that this Azure Endpoint should be created within. Changing this forces a new resource to be created.
    TargetResourceId string
    The ID of the Azure Resource which should be used as a 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 []TrafficManagerAzureEndpointCustomHeaderArgs
    One or more custom_header blocks as defined below.
    Enabled bool
    Is the endpoint enabled? Defaults to true.
    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 Azure 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 []TrafficManagerAzureEndpointSubnetArgs
    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.
    profileId String
    The ID of the Traffic Manager Profile that this Azure Endpoint should be created within. Changing this forces a new resource to be created.
    targetResourceId String
    The ID of the Azure Resource which should be used as a 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<TrafficManagerAzureEndpointCustomHeader>
    One or more custom_header blocks as defined below.
    enabled Boolean
    Is the endpoint enabled? Defaults to true.
    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 Azure 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<TrafficManagerAzureEndpointSubnet>
    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.
    profileId string
    The ID of the Traffic Manager Profile that this Azure Endpoint should be created within. Changing this forces a new resource to be created.
    targetResourceId string
    The ID of the Azure Resource which should be used as a 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 TrafficManagerAzureEndpointCustomHeader[]
    One or more custom_header blocks as defined below.
    enabled boolean
    Is the endpoint enabled? Defaults to true.
    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 Azure 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 TrafficManagerAzureEndpointSubnet[]
    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.
    profile_id str
    The ID of the Traffic Manager Profile that this Azure Endpoint should be created within. Changing this forces a new resource to be created.
    target_resource_id str
    The ID of the Azure Resource which should be used as a 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[TrafficManagerAzureEndpointCustomHeaderArgs]
    One or more custom_header blocks as defined below.
    enabled bool
    Is the endpoint enabled? Defaults to true.
    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 Azure 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[TrafficManagerAzureEndpointSubnetArgs]
    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.
    profileId String
    The ID of the Traffic Manager Profile that this Azure Endpoint should be created within. Changing this forces a new resource to be created.
    targetResourceId String
    The ID of the Azure Resource which should be used as a 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.
    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 Azure 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.

    Outputs

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

    Get an existing TrafficManagerAzureEndpoint 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?: TrafficManagerAzureEndpointState, opts?: CustomResourceOptions): TrafficManagerAzureEndpoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            always_serve_enabled: Optional[bool] = None,
            custom_headers: Optional[Sequence[TrafficManagerAzureEndpointCustomHeaderArgs]] = None,
            enabled: Optional[bool] = None,
            geo_mappings: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            priority: Optional[int] = None,
            profile_id: Optional[str] = None,
            subnets: Optional[Sequence[TrafficManagerAzureEndpointSubnetArgs]] = None,
            target_resource_id: Optional[str] = None,
            weight: Optional[int] = None) -> TrafficManagerAzureEndpoint
    func GetTrafficManagerAzureEndpoint(ctx *Context, name string, id IDInput, state *TrafficManagerAzureEndpointState, opts ...ResourceOption) (*TrafficManagerAzureEndpoint, error)
    public static TrafficManagerAzureEndpoint Get(string name, Input<string> id, TrafficManagerAzureEndpointState? state, CustomResourceOptions? opts = null)
    public static TrafficManagerAzureEndpoint get(String name, Output<String> id, TrafficManagerAzureEndpointState 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<TrafficManagerAzureEndpointCustomHeader>
    One or more custom_header blocks as defined below.
    Enabled bool
    Is the endpoint enabled? Defaults to true.
    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 Azure 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 Azure Endpoint should be created within. Changing this forces a new resource to be created.
    Subnets List<TrafficManagerAzureEndpointSubnet>
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    TargetResourceId string
    The ID of the Azure Resource which should be used as a 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.
    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 []TrafficManagerAzureEndpointCustomHeaderArgs
    One or more custom_header blocks as defined below.
    Enabled bool
    Is the endpoint enabled? Defaults to true.
    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 Azure 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 Azure Endpoint should be created within. Changing this forces a new resource to be created.
    Subnets []TrafficManagerAzureEndpointSubnetArgs
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    TargetResourceId string
    The ID of the Azure Resource which should be used as a 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.
    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<TrafficManagerAzureEndpointCustomHeader>
    One or more custom_header blocks as defined below.
    enabled Boolean
    Is the endpoint enabled? Defaults to true.
    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 Azure 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 Azure Endpoint should be created within. Changing this forces a new resource to be created.
    subnets List<TrafficManagerAzureEndpointSubnet>
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    targetResourceId String
    The ID of the Azure Resource which should be used as a 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.
    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 TrafficManagerAzureEndpointCustomHeader[]
    One or more custom_header blocks as defined below.
    enabled boolean
    Is the endpoint enabled? Defaults to true.
    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 Azure 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 Azure Endpoint should be created within. Changing this forces a new resource to be created.
    subnets TrafficManagerAzureEndpointSubnet[]
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    targetResourceId string
    The ID of the Azure Resource which should be used as a 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.
    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[TrafficManagerAzureEndpointCustomHeaderArgs]
    One or more custom_header blocks as defined below.
    enabled bool
    Is the endpoint enabled? Defaults to true.
    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 Azure 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 Azure Endpoint should be created within. Changing this forces a new resource to be created.
    subnets Sequence[TrafficManagerAzureEndpointSubnetArgs]
    One or more subnet blocks as defined below. Changing this forces a new resource to be created.
    target_resource_id str
    The ID of the Azure Resource which should be used as a 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.
    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.
    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 Azure 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 Azure 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.
    targetResourceId String
    The ID of the Azure Resource which should be used as a 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.

    Supporting Types

    TrafficManagerAzureEndpointCustomHeader, TrafficManagerAzureEndpointCustomHeaderArgs

    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.

    TrafficManagerAzureEndpointSubnet, TrafficManagerAzureEndpointSubnetArgs

    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

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

    $ pulumi import azure:network/trafficManagerAzureEndpoint:TrafficManagerAzureEndpoint example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.Network/trafficManagerProfiles/example-profile/AzureEndpoints/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 Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi