pulumi-azure-native-kotlin/com.pulumi.azurenative.network.kotlin/Endpoint

Endpoint

class Endpoint : KotlinCustomResource

Class representing a Traffic Manager endpoint. Azure REST API version: 2022-04-01. Prior API version in Azure Native 1.x: 2018-08-01. Other available API versions: 2017-03-01, 2018-02-01, 2022-04-01-preview.

Example Usage

Endpoint-PUT-External-WithAlwaysServe

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var endpoint = new AzureNative.Network.Endpoint("endpoint", new()
    {
        AlwaysServe = "Enabled",
        EndpointLocation = "North Europe",
        EndpointName = "azsmnet7187",
        EndpointStatus = "Enabled",
        EndpointType = "ExternalEndpoints",
        Name = "azsmnet7187",
        ProfileName = "azsmnet6386",
        ResourceGroupName = "azuresdkfornetautoresttrafficmanager1421",
        Target = "foobar.contoso.com",
        Type = "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
    });
});

package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/network/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewEndpoint(ctx, "endpoint", &network.EndpointArgs{
			AlwaysServe:       pulumi.String("Enabled"),
			EndpointLocation:  pulumi.String("North Europe"),
			EndpointName:      pulumi.String("azsmnet7187"),
			EndpointStatus:    pulumi.String("Enabled"),
			EndpointType:      pulumi.String("ExternalEndpoints"),
			Name:              pulumi.String("azsmnet7187"),
			ProfileName:       pulumi.String("azsmnet6386"),
			ResourceGroupName: pulumi.String("azuresdkfornetautoresttrafficmanager1421"),
			Target:            pulumi.String("foobar.contoso.com"),
			Type:              pulumi.String("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
		})
		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.azurenative.network.Endpoint;
import com.pulumi.azurenative.network.EndpointArgs;
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 endpoint = new Endpoint("endpoint", EndpointArgs.builder()
            .alwaysServe("Enabled")
            .endpointLocation("North Europe")
            .endpointName("azsmnet7187")
            .endpointStatus("Enabled")
            .endpointType("ExternalEndpoints")
            .name("azsmnet7187")
            .profileName("azsmnet6386")
            .resourceGroupName("azuresdkfornetautoresttrafficmanager1421")
            .target("foobar.contoso.com")
            .type("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints")
            .build());
    }
}

Endpoint-PUT-External-WithCustomHeaders

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var endpoint = new AzureNative.Network.Endpoint("endpoint", new()
    {
        CustomHeaders = new[]
        {
            new AzureNative.Network.Inputs.EndpointPropertiesCustomHeadersArgs
            {
                Name = "header-1",
                Value = "value-1",
            },
            new AzureNative.Network.Inputs.EndpointPropertiesCustomHeadersArgs
            {
                Name = "header-2",
                Value = "value-2",
            },
        },
        EndpointLocation = "North Europe",
        EndpointName = "azsmnet7187",
        EndpointStatus = "Enabled",
        EndpointType = "ExternalEndpoints",
        Name = "azsmnet7187",
        ProfileName = "azsmnet6386",
        ResourceGroupName = "azuresdkfornetautoresttrafficmanager1421",
        Target = "foobar.contoso.com",
        Type = "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
    });
});

package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/network/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewEndpoint(ctx, "endpoint", &network.EndpointArgs{
			CustomHeaders: []network.EndpointPropertiesCustomHeadersArgs{
				{
					Name:  pulumi.String("header-1"),
					Value: pulumi.String("value-1"),
				},
				{
					Name:  pulumi.String("header-2"),
					Value: pulumi.String("value-2"),
				},
			},
			EndpointLocation:  pulumi.String("North Europe"),
			EndpointName:      pulumi.String("azsmnet7187"),
			EndpointStatus:    pulumi.String("Enabled"),
			EndpointType:      pulumi.String("ExternalEndpoints"),
			Name:              pulumi.String("azsmnet7187"),
			ProfileName:       pulumi.String("azsmnet6386"),
			ResourceGroupName: pulumi.String("azuresdkfornetautoresttrafficmanager1421"),
			Target:            pulumi.String("foobar.contoso.com"),
			Type:              pulumi.String("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
		})
		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.azurenative.network.Endpoint;
import com.pulumi.azurenative.network.EndpointArgs;
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 endpoint = new Endpoint("endpoint", EndpointArgs.builder()
            .customHeaders(
                Map.ofEntries(
                    Map.entry("name", "header-1"),
                    Map.entry("value", "value-1")
                ),
                Map.ofEntries(
                    Map.entry("name", "header-2"),
                    Map.entry("value", "value-2")
                ))
            .endpointLocation("North Europe")
            .endpointName("azsmnet7187")
            .endpointStatus("Enabled")
            .endpointType("ExternalEndpoints")
            .name("azsmnet7187")
            .profileName("azsmnet6386")
            .resourceGroupName("azuresdkfornetautoresttrafficmanager1421")
            .target("foobar.contoso.com")
            .type("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints")
            .build());
    }
}

Endpoint-PUT-External-WithGeoMapping

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var endpoint = new AzureNative.Network.Endpoint("endpoint", new()
    {
        EndpointName = "My%20external%20endpoint",
        EndpointStatus = "Enabled",
        EndpointType = "ExternalEndpoints",
        GeoMapping = new[]
        {
            "GEO-AS",
            "GEO-AF",
        },
        Name = "My external endpoint",
        ProfileName = "azuresdkfornetautoresttrafficmanager8224",
        ResourceGroupName = "azuresdkfornetautoresttrafficmanager2191",
        Target = "foobar.contoso.com",
        Type = "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
    });
});

package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/network/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewEndpoint(ctx, "endpoint", &network.EndpointArgs{
			EndpointName:   pulumi.String("My%20external%20endpoint"),
			EndpointStatus: pulumi.String("Enabled"),
			EndpointType:   pulumi.String("ExternalEndpoints"),
			GeoMapping: pulumi.StringArray{
				pulumi.String("GEO-AS"),
				pulumi.String("GEO-AF"),
			},
			Name:              pulumi.String("My external endpoint"),
			ProfileName:       pulumi.String("azuresdkfornetautoresttrafficmanager8224"),
			ResourceGroupName: pulumi.String("azuresdkfornetautoresttrafficmanager2191"),
			Target:            pulumi.String("foobar.contoso.com"),
			Type:              pulumi.String("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
		})
		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.azurenative.network.Endpoint;
import com.pulumi.azurenative.network.EndpointArgs;
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 endpoint = new Endpoint("endpoint", EndpointArgs.builder()
            .endpointName("My%20external%20endpoint")
            .endpointStatus("Enabled")
            .endpointType("ExternalEndpoints")
            .geoMapping(
                "GEO-AS",
                "GEO-AF")
            .name("My external endpoint")
            .profileName("azuresdkfornetautoresttrafficmanager8224")
            .resourceGroupName("azuresdkfornetautoresttrafficmanager2191")
            .target("foobar.contoso.com")
            .type("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints")
            .build());
    }
}

Endpoint-PUT-External-WithLocation

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var endpoint = new AzureNative.Network.Endpoint("endpoint", new()
    {
        EndpointLocation = "North Europe",
        EndpointName = "azsmnet7187",
        EndpointStatus = "Enabled",
        EndpointType = "ExternalEndpoints",
        Name = "azsmnet7187",
        ProfileName = "azsmnet6386",
        ResourceGroupName = "azuresdkfornetautoresttrafficmanager1421",
        Target = "foobar.contoso.com",
        Type = "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
    });
});

package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/network/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewEndpoint(ctx, "endpoint", &network.EndpointArgs{
			EndpointLocation:  pulumi.String("North Europe"),
			EndpointName:      pulumi.String("azsmnet7187"),
			EndpointStatus:    pulumi.String("Enabled"),
			EndpointType:      pulumi.String("ExternalEndpoints"),
			Name:              pulumi.String("azsmnet7187"),
			ProfileName:       pulumi.String("azsmnet6386"),
			ResourceGroupName: pulumi.String("azuresdkfornetautoresttrafficmanager1421"),
			Target:            pulumi.String("foobar.contoso.com"),
			Type:              pulumi.String("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
		})
		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.azurenative.network.Endpoint;
import com.pulumi.azurenative.network.EndpointArgs;
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 endpoint = new Endpoint("endpoint", EndpointArgs.builder()
            .endpointLocation("North Europe")
            .endpointName("azsmnet7187")
            .endpointStatus("Enabled")
            .endpointType("ExternalEndpoints")
            .name("azsmnet7187")
            .profileName("azsmnet6386")
            .resourceGroupName("azuresdkfornetautoresttrafficmanager1421")
            .target("foobar.contoso.com")
            .type("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints")
            .build());
    }
}

Endpoint-PUT-External-WithSubnetMapping

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var endpoint = new AzureNative.Network.Endpoint("endpoint", new()
    {
        EndpointName = "My%20external%20endpoint",
        EndpointStatus = "Enabled",
        EndpointType = "ExternalEndpoints",
        Name = "My external endpoint",
        ProfileName = "azuresdkfornetautoresttrafficmanager8224",
        ResourceGroupName = "azuresdkfornetautoresttrafficmanager2191",
        Subnets = new[]
        {
            new AzureNative.Network.Inputs.EndpointPropertiesSubnetsArgs
            {
                First = "1.2.3.0",
                Scope = 24,
            },
            new AzureNative.Network.Inputs.EndpointPropertiesSubnetsArgs
            {
                First = "25.26.27.28",
                Last = "29.30.31.32",
            },
        },
        Target = "foobar.contoso.com",
        Type = "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
    });
});

package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/network/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewEndpoint(ctx, "endpoint", &network.EndpointArgs{
			EndpointName:      pulumi.String("My%20external%20endpoint"),
			EndpointStatus:    pulumi.String("Enabled"),
			EndpointType:      pulumi.String("ExternalEndpoints"),
			Name:              pulumi.String("My external endpoint"),
			ProfileName:       pulumi.String("azuresdkfornetautoresttrafficmanager8224"),
			ResourceGroupName: pulumi.String("azuresdkfornetautoresttrafficmanager2191"),
			Subnets: []network.EndpointPropertiesSubnetsArgs{
				{
					First: pulumi.String("1.2.3.0"),
					Scope: pulumi.Int(24),
				},
				{
					First: pulumi.String("25.26.27.28"),
					Last:  pulumi.String("29.30.31.32"),
				},
			},
			Target: pulumi.String("foobar.contoso.com"),
			Type:   pulumi.String("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints"),
		})
		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.azurenative.network.Endpoint;
import com.pulumi.azurenative.network.EndpointArgs;
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 endpoint = new Endpoint("endpoint", EndpointArgs.builder()
            .endpointName("My%20external%20endpoint")
            .endpointStatus("Enabled")
            .endpointType("ExternalEndpoints")
            .name("My external endpoint")
            .profileName("azuresdkfornetautoresttrafficmanager8224")
            .resourceGroupName("azuresdkfornetautoresttrafficmanager2191")
            .subnets(
                Map.ofEntries(
                    Map.entry("first", "1.2.3.0"),
                    Map.entry("scope", 24)
                ),
                Map.ofEntries(
                    Map.entry("first", "25.26.27.28"),
                    Map.entry("last", "29.30.31.32")
                ))
            .target("foobar.contoso.com")
            .type("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints")
            .build());
    }
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:Endpoint My external endpoint /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}

Properties

alwaysServe

val alwaysServe: Output<String>?

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

customHeaders

val customHeaders: Output<List<EndpointPropertiesResponseCustomHeaders>>?

List of custom headers.

endpointLocation

val endpointLocation: Output<String>?

Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.

endpointMonitorStatus

val endpointMonitorStatus: Output<String>?

The monitoring status of the endpoint.

endpointStatus

val endpointStatus: Output<String>?

The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.

geoMapping

val geoMapping: Output<List<String>>?

The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values.

val id: Output<String>

minChildEndpoints

val minChildEndpoints: Output<Double>?

The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.

minChildEndpointsIPv4

val minChildEndpointsIPv4: Output<Double>?

The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.

minChildEndpointsIPv6

val minChildEndpointsIPv6: Output<Double>?

The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.

name

val name: Output<String>?

The name of the resource

priority

val priority: Output<Double>?

The priority of this endpoint when using the 'Priority' traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

subnets

val subnets: Output<List<EndpointPropertiesResponseSubnets>>?

The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method. An empty list will match all ranges not covered by other endpoints.

target

val target: Output<String>?

The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.

targetResourceId

val targetResourceId: Output<String>?

The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.

type

val type: Output<String>?

The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

urn

val urn: Output<String>

weight

val weight: Output<Double>?

The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.