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

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.network.TrafficManagerNestedEndpoint

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages a Nested Endpoint within a Traffic Manager Profile.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    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: azurerm_resource_group.test.location,
    resourceGroupName: azurerm_resource_group.test.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: azurerm_resource_group.test.name,
    trafficRoutingMethod: "Priority",
    dnsConfig: {
        relativeName: "nested-profile",
        ttl: 30,
    },
    monitorConfig: {
        protocol: "https",
        port: 443,
        path: "/",
    },
});
const test = new azure.network.TrafficManagerNestedEndpoint("test", {
    targetResourceId: azurerm_traffic_manager_profile.child.id,
    priority: 1,
    profileId: parent.id,
    minChildEndpoints: 5,
});

    Example coming soon!

    Example coming soon!

    Create TrafficManagerNestedEndpoint Resource

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

    Constructor syntax

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

@overload
def TrafficManagerNestedEndpoint(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 minimum_child_endpoints: Optional[int] = None,
                                 weight: Optional[int] = None,
                                 target_resource_id: Optional[str] = None,
                                 profile_id: Optional[str] = None,
                                 geo_mappings: Optional[Sequence[str]] = 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,
                                 custom_headers: Optional[Sequence[TrafficManagerNestedEndpointCustomHeaderArgs]] = None,
                                 subnets: Optional[Sequence[TrafficManagerNestedEndpointSubnetArgs]] = None,
                                 endpoint_location: Optional[str] = None,
                                 enabled: Optional[bool] = 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.

    Parameters

    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.

    Constructor example

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

    var trafficManagerNestedEndpointResource = new Azure.Network.TrafficManagerNestedEndpoint("trafficManagerNestedEndpointResource", new()
{
    MinimumChildEndpoints = 0,
    Weight = 0,
    TargetResourceId = "string",
    ProfileId = "string",
    GeoMappings = new[]
    {
        "string",
    },
    MinimumRequiredChildEndpointsIpv4 = 0,
    MinimumRequiredChildEndpointsIpv6 = 0,
    Name = "string",
    Priority = 0,
    CustomHeaders = new[]
    {
        new Azure.Network.Inputs.TrafficManagerNestedEndpointCustomHeaderArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    Subnets = new[]
    {
        new Azure.Network.Inputs.TrafficManagerNestedEndpointSubnetArgs
        {
            First = "string",
            Last = "string",
            Scope = 0,
        },
    },
    EndpointLocation = "string",
    Enabled = false,
});

    example, err := network.NewTrafficManagerNestedEndpoint(ctx, "trafficManagerNestedEndpointResource", &network.TrafficManagerNestedEndpointArgs{
	MinimumChildEndpoints: pulumi.Int(0),
	Weight:                pulumi.Int(0),
	TargetResourceId:      pulumi.String("string"),
	ProfileId:             pulumi.String("string"),
	GeoMappings: pulumi.StringArray{
		pulumi.String("string"),
	},
	MinimumRequiredChildEndpointsIpv4: pulumi.Int(0),
	MinimumRequiredChildEndpointsIpv6: pulumi.Int(0),
	Name:                              pulumi.String("string"),
	Priority:                          pulumi.Int(0),
	CustomHeaders: network.TrafficManagerNestedEndpointCustomHeaderArray{
		&network.TrafficManagerNestedEndpointCustomHeaderArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Subnets: network.TrafficManagerNestedEndpointSubnetArray{
		&network.TrafficManagerNestedEndpointSubnetArgs{
			First: pulumi.String("string"),
			Last:  pulumi.String("string"),
			Scope: pulumi.Int(0),
		},
	},
	EndpointLocation: pulumi.String("string"),
	Enabled:          pulumi.Bool(false),
})

    var trafficManagerNestedEndpointResource = new TrafficManagerNestedEndpoint("trafficManagerNestedEndpointResource", TrafficManagerNestedEndpointArgs.builder()
    .minimumChildEndpoints(0)
    .weight(0)
    .targetResourceId("string")
    .profileId("string")
    .geoMappings("string")
    .minimumRequiredChildEndpointsIpv4(0)
    .minimumRequiredChildEndpointsIpv6(0)
    .name("string")
    .priority(0)
    .customHeaders(TrafficManagerNestedEndpointCustomHeaderArgs.builder()
        .name("string")
        .value("string")
        .build())
    .subnets(TrafficManagerNestedEndpointSubnetArgs.builder()
        .first("string")
        .last("string")
        .scope(0)
        .build())
    .endpointLocation("string")
    .enabled(false)
    .build());

    traffic_manager_nested_endpoint_resource = azure.network.TrafficManagerNestedEndpoint("trafficManagerNestedEndpointResource",
    minimum_child_endpoints=0,
    weight=0,
    target_resource_id="string",
    profile_id="string",
    geo_mappings=["string"],
    minimum_required_child_endpoints_ipv4=0,
    minimum_required_child_endpoints_ipv6=0,
    name="string",
    priority=0,
    custom_headers=[{
        "name": "string",
        "value": "string",
    }],
    subnets=[{
        "first": "string",
        "last": "string",
        "scope": 0,
    }],
    endpoint_location="string",
    enabled=False)

    const trafficManagerNestedEndpointResource = new azure.network.TrafficManagerNestedEndpoint("trafficManagerNestedEndpointResource", {
    minimumChildEndpoints: 0,
    weight: 0,
    targetResourceId: "string",
    profileId: "string",
    geoMappings: ["string"],
    minimumRequiredChildEndpointsIpv4: 0,
    minimumRequiredChildEndpointsIpv6: 0,
    name: "string",
    priority: 0,
    customHeaders: [{
        name: "string",
        value: "string",
    }],
    subnets: [{
        first: "string",
        last: "string",
        scope: 0,
    }],
    endpointLocation: "string",
    enabled: false,
});

    type: azure:network:TrafficManagerNestedEndpoint
properties:
    customHeaders:
        - name: string
          value: string
    enabled: false
    endpointLocation: string
    geoMappings:
        - string
    minimumChildEndpoints: 0
    minimumRequiredChildEndpointsIpv4: 0
    minimumRequiredChildEndpointsIpv6: 0
    name: string
    priority: 0
    profileId: string
    subnets:
        - first: string
          last: string
          scope: 0
    targetResourceId: string
    weight: 0

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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.
    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.
    Weight int
    Specifies how much traffic should be distributed to this endpoint. Valid values are between 1 and 1000.
    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 defaults to 1.
    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 defaults to 1.
    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
    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.
    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.
    Weight int
    Specifies how much traffic should be distributed to this endpoint. 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.
    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 defaults to 1.
    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 defaults to 1.
    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
    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.
    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.
    weight Integer
    Specifies how much traffic should be distributed to this endpoint. 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.
    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 defaults to 1.
    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 defaults to 1.
    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
    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.
    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.
    weight number
    Specifies how much traffic should be distributed to this endpoint. 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.
    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 defaults to 1.
    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 defaults to 1.
    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
    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.
    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.
    weight int
    Specifies how much traffic should be distributed to this endpoint. 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_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 defaults to 1.
    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 defaults to 1.
    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
    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.
    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.
    weight Number
    Specifies how much traffic should be distributed to this endpoint. 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.
    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 defaults to 1.
    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 defaults to 1.
    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

    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)
    resources:  _:    type: azure:network:TrafficManagerNestedEndpoint    get:      id: ${id}
    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.
    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 defaults to 1.
    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 defaults to 1.
    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
    TargetResourceId string
    The resource id of an Azure resource to target.
    Weight int
    Specifies how much traffic should be distributed to this endpoint. 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.
    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 defaults to 1.
    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 defaults to 1.
    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
    TargetResourceId string
    The resource id of an Azure resource to target.
    Weight int
    Specifies how much traffic should be distributed to this endpoint. 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.
    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 defaults to 1.
    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 defaults to 1.
    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
    targetResourceId String
    The resource id of an Azure resource to target.
    weight Integer
    Specifies how much traffic should be distributed to this endpoint. 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.
    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 defaults to 1.
    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 defaults to 1.
    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
    targetResourceId string
    The resource id of an Azure resource to target.
    weight number
    Specifies how much traffic should be distributed to this endpoint. 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.
    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 defaults to 1.
    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 defaults to 1.
    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
    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. 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.
    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 defaults to 1.
    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 defaults to 1.
    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
    targetResourceId String
    The resource id of an Azure resource to target.
    weight Number
    Specifies how much traffic should be distributed to this endpoint. 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

    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.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.