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

Endpoint

class Endpoint : KotlinCustomResource

Class representing a Traffic Manager endpoint. Uses Azure REST API version 2022-04-01. In version 1.x of the Azure Native provider, it used API version 2018-08-01. Other available API versions: 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 = AzureNative.Network.AlwaysServe.Enabled,
        EndpointLocation = "North Europe",
        EndpointName = "azsmnet7187",
        EndpointStatus = AzureNative.Network.EndpointStatus.Enabled,
        EndpointType = "ExternalEndpoints",
        Name = "azsmnet7187",
        ProfileName = "azsmnet6386",
        ResourceGroupName = "azuresdkfornetautoresttrafficmanager1421",
        Target = "foobar.contoso.com",
        Type = "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
    });
});
Content copied to clipboard
package main
import (
	network "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(network.AlwaysServeEnabled),
			EndpointLocation:  pulumi.String("North Europe"),
			EndpointName:      pulumi.String("azsmnet7187"),
			EndpointStatus:    pulumi.String(network.EndpointStatusEnabled),
			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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard

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 = AzureNative.Network.EndpointStatus.Enabled,
        EndpointType = "ExternalEndpoints",
        Name = "azsmnet7187",
        ProfileName = "azsmnet6386",
        ResourceGroupName = "azuresdkfornetautoresttrafficmanager1421",
        Target = "foobar.contoso.com",
        Type = "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
    });
});
Content copied to clipboard
package main
import (
	network "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.EndpointPropertiesCustomHeadersArray{
				&network.EndpointPropertiesCustomHeadersArgs{
					Name:  pulumi.String("header-1"),
					Value: pulumi.String("value-1"),
				},
				&network.EndpointPropertiesCustomHeadersArgs{
					Name:  pulumi.String("header-2"),
					Value: pulumi.String("value-2"),
				},
			},
			EndpointLocation:  pulumi.String("North Europe"),
			EndpointName:      pulumi.String("azsmnet7187"),
			EndpointStatus:    pulumi.String(network.EndpointStatusEnabled),
			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
	})
}
Content copied to clipboard
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 com.pulumi.azurenative.network.inputs.EndpointPropertiesCustomHeadersArgs;
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(
                EndpointPropertiesCustomHeadersArgs.builder()
                    .name("header-1")
                    .value("value-1")
                    .build(),
                EndpointPropertiesCustomHeadersArgs.builder()
                    .name("header-2")
                    .value("value-2")
                    .build())
            .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());
    }
}
Content copied to clipboard

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 = AzureNative.Network.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",
    });
});
Content copied to clipboard
package main
import (
	network "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(network.EndpointStatusEnabled),
			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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard

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 = AzureNative.Network.EndpointStatus.Enabled,
        EndpointType = "ExternalEndpoints",
        Name = "azsmnet7187",
        ProfileName = "azsmnet6386",
        ResourceGroupName = "azuresdkfornetautoresttrafficmanager1421",
        Target = "foobar.contoso.com",
        Type = "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
    });
});
Content copied to clipboard
package main
import (
	network "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(network.EndpointStatusEnabled),
			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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard

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 = AzureNative.Network.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",
    });
});
Content copied to clipboard
package main
import (
	network "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(network.EndpointStatusEnabled),
			EndpointType:      pulumi.String("ExternalEndpoints"),
			Name:              pulumi.String("My external endpoint"),
			ProfileName:       pulumi.String("azuresdkfornetautoresttrafficmanager8224"),
			ResourceGroupName: pulumi.String("azuresdkfornetautoresttrafficmanager2191"),
			Subnets: network.EndpointPropertiesSubnetsArray{
				&network.EndpointPropertiesSubnetsArgs{
					First: pulumi.String("1.2.3.0"),
					Scope: pulumi.Int(24),
				},
				&network.EndpointPropertiesSubnetsArgs{
					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
	})
}
Content copied to clipboard
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 com.pulumi.azurenative.network.inputs.EndpointPropertiesSubnetsArgs;
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(
                EndpointPropertiesSubnetsArgs.builder()
                    .first("1.2.3.0")
                    .scope(24)
                    .build(),
                EndpointPropertiesSubnetsArgs.builder()
                    .first("25.26.27.28")
                    .last("29.30.31.32")
                    .build())
            .target("foobar.contoso.com")
            .type("Microsoft.network/TrafficManagerProfiles/ExternalEndpoints")
            .build());
    }
}
Content copied to clipboard

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}
Content copied to clipboard

Properties

Link copied to clipboard
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.

Link copied to clipboard
val customHeaders: Output<List<EndpointPropertiesResponseCustomHeaders>>?

List of custom headers.

Link copied to clipboard
val endpointLocation: Output<String>?

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

Link copied to clipboard
val endpointMonitorStatus: Output<String>?

The monitoring status of the endpoint.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
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'.

Link copied to clipboard
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'.

Link copied to clipboard
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'.

Link copied to clipboard
val name: Output<String>?

The name of the resource

Link copied to clipboard
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.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
val targetResourceId: Output<String>?

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

Link copied to clipboard
val type: Output<String>?

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

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val weight: Output<Double>?

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