Class Endpoint

Manages a Traffic Manager Endpoint.

Inheritance

System.Object

Resource

CustomResource

Endpoint

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.TrafficManager

Assembly: Pulumi.Azure.dll

Syntax

[Obsolete("azure.trafficmanager.Endpoint has been deprecated in favor of azure.network.TrafficManagerEndpoint")]
public class Endpoint : CustomResource

Constructors

Endpoint(String, EndpointArgs, CustomResourceOptions)

Create a Endpoint resource with the given unique name, arguments, and options.

Declaration

public Endpoint(string name, EndpointArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EndpointArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

CustomHeaders

One or more custom_header blocks as defined below

Declaration

public Output<ImmutableArray<EndpointCustomHeader>> CustomHeaders { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<EndpointCustomHeader>>

EndpointLocation

Specifies the Azure location of the Endpoint, this must be specified for Profiles using the Performance routing method if the Endpoint is of either type nestedEndpoints or externalEndpoints. For Endpoints of type azureEndpoints the value will be taken from the location of the Azure target resource.

Declaration

public Output<string> EndpointLocation { get; }

Property Value

Type	Description
Output<System.String>

EndpointMonitorStatus

Declaration

public Output<string> EndpointMonitorStatus { get; }

Property Value

Type	Description
Output<System.String>

EndpointStatus

The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.

Declaration

public Output<string> EndpointStatus { get; }

Property Value

Type	Description
Output<System.String>

GeoMappings

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.

Declaration

public Output<ImmutableArray<string>> GeoMappings { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

MinChildEndpoints

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 argument only applies to Endpoints of type nestedEndpoints and defaults to 1.

Declaration

public Output<int?> MinChildEndpoints { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Name

The name of the Traffic Manager endpoint. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Priority

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.

Declaration

public Output<int> Priority { get; }

Property Value

Type	Description
Output<System.Int32>

ProfileName

The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.

Declaration

public Output<string> ProfileName { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the resource group in which to create the Traffic Manager endpoint.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

Subnets

One or more subnet blocks as defined below

Declaration

public Output<ImmutableArray<EndpointSubnet>> Subnets { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<EndpointSubnet>>

Target

The FQDN DNS name of the target. This argument must be provided for an endpoint of type externalEndpoints, for other types it will be computed.

Declaration

public Output<string> Target { get; }

Property Value

Type	Description
Output<System.String>

TargetResourceId

The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.

Declaration

public Output<string> TargetResourceId { get; }

Property Value

Type	Description
Output<System.String>

Type

The Endpoint type, must be one of:

• azureEndpoints
• externalEndpoints
• nestedEndpoints

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

Weight

Specifies how much traffic should be distributed to this endpoint, this must be specified for Profiles using the Weighted traffic routing method. Supports values between 1 and 1000.

Declaration

public Output<int> Weight { get; }

Property Value

Type	Description
Output<System.Int32>

Methods

Get(String, Input<String>, EndpointState, CustomResourceOptions)

Get an existing Endpoint resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Endpoint Get(string name, Input<string> id, EndpointState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EndpointState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Endpoint