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

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi
pulumi/pulumi-azure

azure.network.TrafficManagerNestedEndpoint

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi
pulumi/pulumi-azure

    Manages a Nested Endpoint within a Traffic Manager Profile.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var examplePublicIp = new Azure.Network.PublicIp("examplePublicIp", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        AllocationMethod = "Static",
        DomainNameLabel = "example-pip",
    });

    var parent = new Azure.Network.TrafficManagerProfile("parent", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        TrafficRoutingMethod = "Weighted",
        DnsConfig = new Azure.Network.Inputs.TrafficManagerProfileDnsConfigArgs
        {
            RelativeName = "parent-profile",
            Ttl = 100,
        },
        MonitorConfig = new Azure.Network.Inputs.TrafficManagerProfileMonitorConfigArgs
        {
            Protocol = "HTTP",
            Port = 80,
            Path = "/",
            IntervalInSeconds = 30,
            TimeoutInSeconds = 9,
            ToleratedNumberOfFailures = 3,
        },
        Tags = 
        {
            { "environment", "Production" },
        },
    });

    var nested = new Azure.Network.TrafficManagerProfile("nested", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        TrafficRoutingMethod = "Priority",
        DnsConfig = new Azure.Network.Inputs.TrafficManagerProfileDnsConfigArgs
        {
            RelativeName = "nested-profile",
            Ttl = 30,
        },
        MonitorConfig = new Azure.Network.Inputs.TrafficManagerProfileMonitorConfigArgs
        {
            Protocol = "HTTP",
            Port = 443,
            Path = "/",
        },
    });

    var exampleTrafficManagerNestedEndpoint = new Azure.Network.TrafficManagerNestedEndpoint("exampleTrafficManagerNestedEndpoint", new()
    {
        TargetResourceId = nested.Id,
        Priority = 1,
        ProfileId = parent.Id,
        MinimumChildEndpoints = 9,
        Weight = 5,
    });

});

    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 {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = network.NewPublicIp(ctx, "examplePublicIp", &network.PublicIpArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			AllocationMethod:  pulumi.String("Static"),
			DomainNameLabel:   pulumi.String("example-pip"),
		})
		if err != nil {
			return err
		}
		parent, err := network.NewTrafficManagerProfile(ctx, "parent", &network.TrafficManagerProfileArgs{
			ResourceGroupName:    exampleResourceGroup.Name,
			TrafficRoutingMethod: pulumi.String("Weighted"),
			DnsConfig: &network.TrafficManagerProfileDnsConfigArgs{
				RelativeName: pulumi.String("parent-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
		}
		nested, err := network.NewTrafficManagerProfile(ctx, "nested", &network.TrafficManagerProfileArgs{
			ResourceGroupName:    exampleResourceGroup.Name,
			TrafficRoutingMethod: pulumi.String("Priority"),
			DnsConfig: &network.TrafficManagerProfileDnsConfigArgs{
				RelativeName: pulumi.String("nested-profile"),
				Ttl:          pulumi.Int(30),
			},
			MonitorConfig: &network.TrafficManagerProfileMonitorConfigArgs{
				Protocol: pulumi.String("HTTP"),
				Port:     pulumi.Int(443),
				Path:     pulumi.String("/"),
			},
		})
		if err != nil {
			return err
		}
		_, err = network.NewTrafficManagerNestedEndpoint(ctx, "exampleTrafficManagerNestedEndpoint", &network.TrafficManagerNestedEndpointArgs{
			TargetResourceId:      nested.ID(),
			Priority:              pulumi.Int(1),
			ProfileId:             parent.ID(),
			MinimumChildEndpoints: pulumi.Int(9),
			Weight:                pulumi.Int(5),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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.TrafficManagerNestedEndpoint;
import com.pulumi.azure.network.TrafficManagerNestedEndpointArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .allocationMethod("Static")
            .domainNameLabel("example-pip")
            .build());

        var parent = new TrafficManagerProfile("parent", TrafficManagerProfileArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .trafficRoutingMethod("Weighted")
            .dnsConfig(TrafficManagerProfileDnsConfigArgs.builder()
                .relativeName("parent-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 nested = new TrafficManagerProfile("nested", TrafficManagerProfileArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .trafficRoutingMethod("Priority")
            .dnsConfig(TrafficManagerProfileDnsConfigArgs.builder()
                .relativeName("nested-profile")
                .ttl(30)
                .build())
            .monitorConfig(TrafficManagerProfileMonitorConfigArgs.builder()
                .protocol("HTTP")
                .port(443)
                .path("/")
                .build())
            .build());

        var exampleTrafficManagerNestedEndpoint = new TrafficManagerNestedEndpoint("exampleTrafficManagerNestedEndpoint", TrafficManagerNestedEndpointArgs.builder()        
            .targetResourceId(nested.id())
            .priority(1)
            .profileId(parent.id())
            .minimumChildEndpoints(9)
            .weight(5)
            .build());

    }
}

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_public_ip = azure.network.PublicIp("examplePublicIp",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    allocation_method="Static",
    domain_name_label="example-pip")
parent = azure.network.TrafficManagerProfile("parent",
    resource_group_name=example_resource_group.name,
    traffic_routing_method="Weighted",
    dns_config=azure.network.TrafficManagerProfileDnsConfigArgs(
        relative_name="parent-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",
    })
nested = azure.network.TrafficManagerProfile("nested",
    resource_group_name=example_resource_group.name,
    traffic_routing_method="Priority",
    dns_config=azure.network.TrafficManagerProfileDnsConfigArgs(
        relative_name="nested-profile",
        ttl=30,
    ),
    monitor_config=azure.network.TrafficManagerProfileMonitorConfigArgs(
        protocol="HTTP",
        port=443,
        path="/",
    ))
example_traffic_manager_nested_endpoint = azure.network.TrafficManagerNestedEndpoint("exampleTrafficManagerNestedEndpoint",
    target_resource_id=nested.id,
    priority=1,
    profile_id=parent.id,
    minimum_child_endpoints=9,
    weight=5)

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    allocationMethod: "Static",
    domainNameLabel: "example-pip",
});
const parent = new azure.network.TrafficManagerProfile("parent", {
    resourceGroupName: exampleResourceGroup.name,
    trafficRoutingMethod: "Weighted",
    dnsConfig: {
        relativeName: "parent-profile",
        ttl: 100,
    },
    monitorConfig: {
        protocol: "HTTP",
        port: 80,
        path: "/",
        intervalInSeconds: 30,
        timeoutInSeconds: 9,
        toleratedNumberOfFailures: 3,
    },
    tags: {
        environment: "Production",
    },
});
const nested = new azure.network.TrafficManagerProfile("nested", {
    resourceGroupName: exampleResourceGroup.name,
    trafficRoutingMethod: "Priority",
    dnsConfig: {
        relativeName: "nested-profile",
        ttl: 30,
    },
    monitorConfig: {
        protocol: "HTTP",
        port: 443,
        path: "/",
    },
});
const exampleTrafficManagerNestedEndpoint = new azure.network.TrafficManagerNestedEndpoint("exampleTrafficManagerNestedEndpoint", {
    targetResourceId: nested.id,
    priority: 1,
    profileId: parent.id,
    minimumChildEndpoints: 9,
    weight: 5,
});

    resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  examplePublicIp:
    type: azure:network:PublicIp
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      allocationMethod: Static
      domainNameLabel: example-pip
  parent:
    type: azure:network:TrafficManagerProfile
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      trafficRoutingMethod: Weighted
      dnsConfig:
        relativeName: parent-profile
        ttl: 100
      monitorConfig:
        protocol: HTTP
        port: 80
        path: /
        intervalInSeconds: 30
        timeoutInSeconds: 9
        toleratedNumberOfFailures: 3
      tags:
        environment: Production
  nested:
    type: azure:network:TrafficManagerProfile
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      trafficRoutingMethod: Priority
      dnsConfig:
        relativeName: nested-profile
        ttl: 30
      monitorConfig:
        protocol: HTTP
        port: 443
        path: /
  exampleTrafficManagerNestedEndpoint:
    type: azure:network:TrafficManagerNestedEndpoint
    properties:
      targetResourceId: ${nested.id}
      priority: 1
      profileId: ${parent.id}
      minimumChildEndpoints: 9
      weight: 5

    Create TrafficManagerNestedEndpoint Resource

    new TrafficManagerNestedEndpoint(name: string, args: TrafficManagerNestedEndpointArgs, opts?: CustomResourceOptions);
    @overload
def TrafficManagerNestedEndpoint(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 custom_headers: Optional[Sequence[TrafficManagerNestedEndpointCustomHeaderArgs]] = None,
                                 enabled: Optional[bool] = None,
                                 endpoint_location: Optional[str] = None,
                                 geo_mappings: Optional[Sequence[str]] = None,
                                 minimum_child_endpoints: Optional[int] = None,
                                 minimum_required_child_endpoints_ipv4: Optional[int] = None,
                                 minimum_required_child_endpoints_ipv6: Optional[int] = None,
                                 name: Optional[str] = None,
                                 priority: Optional[int] = None,
                                 profile_id: Optional[str] = None,
                                 subnets: Optional[Sequence[TrafficManagerNestedEndpointSubnetArgs]] = None,
                                 target_resource_id: Optional[str] = None,
                                 weight: Optional[int] = None)
@overload
def TrafficManagerNestedEndpoint(resource_name: str,
                                 args: TrafficManagerNestedEndpointArgs,
                                 opts: Optional[ResourceOptions] = None)
    func NewTrafficManagerNestedEndpoint(ctx *Context, name string, args TrafficManagerNestedEndpointArgs, opts ...ResourceOption) (*TrafficManagerNestedEndpoint, error)
    public TrafficManagerNestedEndpoint(string name, TrafficManagerNestedEndpointArgs args, CustomResourceOptions? opts = null)
    public TrafficManagerNestedEndpoint(String name, TrafficManagerNestedEndpointArgs args)
public TrafficManagerNestedEndpoint(String name, TrafficManagerNestedEndpointArgs args, CustomResourceOptions options)

    type: azure:network:TrafficManagerNestedEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TrafficManagerNestedEndpointArgs
    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 TrafficManagerNestedEndpointArgs
    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 TrafficManagerNestedEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TrafficManagerNestedEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TrafficManagerNestedEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    MinimumChildEndpoints int

    This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This value must be larger than 0.

    ~>NOTE: If min_child_endpoints is less than either minimum_required_child_endpoints_ipv4 or minimum_required_child_endpoints_ipv6, then it won't have any effect.

    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.

    TargetResourceId string

    The resource id of an Azure resource to target.

    CustomHeaders List<TrafficManagerNestedEndpointCustomHeader>

    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.

    MinimumRequiredChildEndpointsIpv4 int

    This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    MinimumRequiredChildEndpointsIpv6 int

    This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    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<TrafficManagerNestedEndpointSubnet>

    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.

    MinimumChildEndpoints int

    This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This value must be larger than 0.

    ~>NOTE: If min_child_endpoints is less than either minimum_required_child_endpoints_ipv4 or minimum_required_child_endpoints_ipv6, then it won't have any effect.

    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.

    TargetResourceId string

    The resource id of an Azure resource to target.

    CustomHeaders []TrafficManagerNestedEndpointCustomHeaderArgs

    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.

    MinimumRequiredChildEndpointsIpv4 int

    This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    MinimumRequiredChildEndpointsIpv6 int

    This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    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 []TrafficManagerNestedEndpointSubnetArgs

    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.

    minimumChildEndpoints Integer

    This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This value must be larger than 0.

    ~>NOTE: If min_child_endpoints is less than either minimum_required_child_endpoints_ipv4 or minimum_required_child_endpoints_ipv6, then it won't have any effect.

    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.

    targetResourceId String

    The resource id of an Azure resource to target.

    customHeaders List<TrafficManagerNestedEndpointCustomHeader>

    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.

    minimumRequiredChildEndpointsIpv4 Integer

    This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    minimumRequiredChildEndpointsIpv6 Integer

    This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    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<TrafficManagerNestedEndpointSubnet>

    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.

    minimumChildEndpoints number

    This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This value must be larger than 0.

    ~>NOTE: If min_child_endpoints is less than either minimum_required_child_endpoints_ipv4 or minimum_required_child_endpoints_ipv6, then it won't have any effect.

    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.

    targetResourceId string

    The resource id of an Azure resource to target.

    customHeaders TrafficManagerNestedEndpointCustomHeader[]

    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.

    minimumRequiredChildEndpointsIpv4 number

    This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    minimumRequiredChildEndpointsIpv6 number

    This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    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 TrafficManagerNestedEndpointSubnet[]

    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.

    minimum_child_endpoints int

    This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This value must be larger than 0.

    ~>NOTE: If min_child_endpoints is less than either minimum_required_child_endpoints_ipv4 or minimum_required_child_endpoints_ipv6, then it won't have any effect.

    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_resource_id str

    The resource id of an Azure resource to target.

    custom_headers Sequence[TrafficManagerNestedEndpointCustomHeaderArgs]

    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.

    minimum_required_child_endpoints_ipv4 int

    This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    minimum_required_child_endpoints_ipv6 int

    This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    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[TrafficManagerNestedEndpointSubnetArgs]

    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.

    minimumChildEndpoints Number

    This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This value must be larger than 0.

    ~>NOTE: If min_child_endpoints is less than either minimum_required_child_endpoints_ipv4 or minimum_required_child_endpoints_ipv6, then it won't have any effect.

    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.

    targetResourceId String

    The resource id of an Azure resource to target.

    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.

    minimumRequiredChildEndpointsIpv4 Number

    This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    minimumRequiredChildEndpointsIpv6 Number

    This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    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.

    Outputs

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

    Get an existing TrafficManagerNestedEndpoint 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?: TrafficManagerNestedEndpointState, opts?: CustomResourceOptions): TrafficManagerNestedEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_headers: Optional[Sequence[TrafficManagerNestedEndpointCustomHeaderArgs]] = None,
        enabled: Optional[bool] = None,
        endpoint_location: Optional[str] = None,
        geo_mappings: Optional[Sequence[str]] = None,
        minimum_child_endpoints: Optional[int] = None,
        minimum_required_child_endpoints_ipv4: Optional[int] = None,
        minimum_required_child_endpoints_ipv6: Optional[int] = None,
        name: Optional[str] = None,
        priority: Optional[int] = None,
        profile_id: Optional[str] = None,
        subnets: Optional[Sequence[TrafficManagerNestedEndpointSubnetArgs]] = None,
        target_resource_id: Optional[str] = None,
        weight: Optional[int] = None) -> TrafficManagerNestedEndpoint
    func GetTrafficManagerNestedEndpoint(ctx *Context, name string, id IDInput, state *TrafficManagerNestedEndpointState, opts ...ResourceOption) (*TrafficManagerNestedEndpoint, error)
    public static TrafficManagerNestedEndpoint Get(string name, Input<string> id, TrafficManagerNestedEndpointState? state, CustomResourceOptions? opts = null)
    public static TrafficManagerNestedEndpoint get(String name, Output<String> id, TrafficManagerNestedEndpointState 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:
    CustomHeaders List<TrafficManagerNestedEndpointCustomHeader>

    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.

    MinimumChildEndpoints int

    This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This value must be larger than 0.

    ~>NOTE: If min_child_endpoints is less than either minimum_required_child_endpoints_ipv4 or minimum_required_child_endpoints_ipv6, then it won't have any effect.

    MinimumRequiredChildEndpointsIpv4 int

    This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    MinimumRequiredChildEndpointsIpv6 int

    This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    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<TrafficManagerNestedEndpointSubnet>

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

    TargetResourceId string

    The resource id of an Azure resource to 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.

    CustomHeaders []TrafficManagerNestedEndpointCustomHeaderArgs

    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.

    MinimumChildEndpoints int

    This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This value must be larger than 0.

    ~>NOTE: If min_child_endpoints is less than either minimum_required_child_endpoints_ipv4 or minimum_required_child_endpoints_ipv6, then it won't have any effect.

    MinimumRequiredChildEndpointsIpv4 int

    This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    MinimumRequiredChildEndpointsIpv6 int

    This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    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 []TrafficManagerNestedEndpointSubnetArgs

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

    TargetResourceId string

    The resource id of an Azure resource to 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.

    customHeaders List<TrafficManagerNestedEndpointCustomHeader>

    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.

    minimumChildEndpoints Integer

    This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This value must be larger than 0.

    ~>NOTE: If min_child_endpoints is less than either minimum_required_child_endpoints_ipv4 or minimum_required_child_endpoints_ipv6, then it won't have any effect.

    minimumRequiredChildEndpointsIpv4 Integer

    This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    minimumRequiredChildEndpointsIpv6 Integer

    This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    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<TrafficManagerNestedEndpointSubnet>

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

    targetResourceId String

    The resource id of an Azure resource to 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.

    customHeaders TrafficManagerNestedEndpointCustomHeader[]

    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.

    minimumChildEndpoints number

    This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This value must be larger than 0.

    ~>NOTE: If min_child_endpoints is less than either minimum_required_child_endpoints_ipv4 or minimum_required_child_endpoints_ipv6, then it won't have any effect.

    minimumRequiredChildEndpointsIpv4 number

    This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    minimumRequiredChildEndpointsIpv6 number

    This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    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 TrafficManagerNestedEndpointSubnet[]

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

    targetResourceId string

    The resource id of an Azure resource to 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.

    custom_headers Sequence[TrafficManagerNestedEndpointCustomHeaderArgs]

    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.

    minimum_child_endpoints int

    This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This value must be larger than 0.

    ~>NOTE: If min_child_endpoints is less than either minimum_required_child_endpoints_ipv4 or minimum_required_child_endpoints_ipv6, then it won't have any effect.

    minimum_required_child_endpoints_ipv4 int

    This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    minimum_required_child_endpoints_ipv6 int

    This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    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[TrafficManagerNestedEndpointSubnetArgs]

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

    target_resource_id str

    The resource id of an Azure resource to 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.

    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.

    minimumChildEndpoints Number

    This argument specifies the minimum number of endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This value must be larger than 0.

    ~>NOTE: If min_child_endpoints is less than either minimum_required_child_endpoints_ipv4 or minimum_required_child_endpoints_ipv6, then it won't have any effect.

    minimumRequiredChildEndpointsIpv4 Number

    This argument specifies the minimum number of IPv4 (DNS record type A) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    minimumRequiredChildEndpointsIpv6 Number

    This argument specifies the minimum number of IPv6 (DNS record type AAAA) endpoints that must be ‘online’ in the child profile in order for the parent profile to direct traffic to any of the endpoints in that child profile. This argument only applies to Endpoints of type nestedEndpoints and

    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.

    targetResourceId String

    The resource id of an Azure resource to 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

    TrafficManagerNestedEndpointCustomHeader, TrafficManagerNestedEndpointCustomHeaderArgs

    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.

    TrafficManagerNestedEndpointSubnet, TrafficManagerNestedEndpointSubnetArgs

    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

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

     $ pulumi import azure:network/trafficManagerNestedEndpoint:TrafficManagerNestedEndpoint example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.Network/trafficManagerProfiles/example-profile/NestedEndpoints/example-endpoint

    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.58.0 published on Saturday, Dec 2, 2023 by Pulumi
    pulumi/pulumi-azure