Endpoint

Manages a Traffic Manager Endpoint.

Deprecated: azure.trafficmanager.Endpoint has been deprecated in favor of azure.network.TrafficManagerEndpoint

Create a Endpoint Resource

new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);

def Endpoint(resource_name, opts=None, custom_headers=None, endpoint_location=None, endpoint_status=None, geo_mappings=None, min_child_endpoints=None, name=None, priority=None, profile_name=None, resource_group_name=None, subnets=None, target=None, target_resource_id=None, type=None, weight=None, __props__=None);

func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)

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

name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Endpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Endpoint resource accepts the following input properties:

ProfileName string: The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.
ResourceGroupName string: The name of the resource group where the Traffic Manager Profile exists.
Type string: The Endpoint type, must be one of: - azureEndpoints - externalEndpoints - nestedEndpoints
CustomHeaders List<EndpointCustomHeaderArgs>: One or more custom_header blocks as defined below
EndpointLocation string: 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.
EndpointStatus string: The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.
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.
MinChildEndpoints 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 argument only applies to Endpoints of type nestedEndpoints and defaults to 1.
Name string: The name of the Traffic Manager 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<EndpointSubnetArgs>: One or more subnet blocks as defined below
Target string: 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.
TargetResourceId string: The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.
Weight int: 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.

ProfileName string: The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.
ResourceGroupName string: The name of the resource group where the Traffic Manager Profile exists.
Type string: The Endpoint type, must be one of: - azureEndpoints - externalEndpoints - nestedEndpoints
CustomHeaders []EndpointCustomHeader: One or more custom_header blocks as defined below
EndpointLocation string: 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.
EndpointStatus string: The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.
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.
MinChildEndpoints 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 argument only applies to Endpoints of type nestedEndpoints and defaults to 1.
Name string: The name of the Traffic Manager 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 []EndpointSubnet: One or more subnet blocks as defined below
Target string: 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.
TargetResourceId string: The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.
Weight int: 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.

profileName string: The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.
resourceGroupName string: The name of the resource group where the Traffic Manager Profile exists.
type string: The Endpoint type, must be one of: - azureEndpoints - externalEndpoints - nestedEndpoints
customHeaders EndpointCustomHeader[]: One or more custom_header blocks as defined below
endpointLocation string: 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.
endpointStatus string: The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.
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.
minChildEndpoints 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 argument only applies to Endpoints of type nestedEndpoints and defaults to 1.
name string: The name of the Traffic Manager 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 EndpointSubnet[]: One or more subnet blocks as defined below
target string: 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.
targetResourceId string: The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.
weight number: 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.

profile_name str: The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.
resource_group_name str: The name of the resource group where the Traffic Manager Profile exists.
type str: The Endpoint type, must be one of: - azureEndpoints - externalEndpoints - nestedEndpoints
custom_headers List[EndpointCustomHeader]: One or more custom_header blocks as defined below
endpoint_location str: 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.
endpoint_status str: The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.
geo_mappings List[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.
min_child_endpoints float: 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.
name str: The name of the Traffic Manager endpoint. Changing this forces a new resource to be created.
priority float: 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[EndpointSubnet]: One or more subnet blocks as defined below
target str: 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.
target_resource_id str: The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.
weight float: 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Endpoint resource produces the following output properties:

EndpointMonitorStatus string
Id string: The provider-assigned unique ID for this managed resource.

EndpointMonitorStatus string
Id string: The provider-assigned unique ID for this managed resource.

endpointMonitorStatus string
id string: The provider-assigned unique ID for this managed resource.

endpoint_monitor_status str
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Endpoint Resource

Get an existing Endpoint 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?: EndpointState, opts?: CustomResourceOptions): Endpoint

static get(resource_name, id, opts=None, custom_headers=None, endpoint_location=None, endpoint_monitor_status=None, endpoint_status=None, geo_mappings=None, min_child_endpoints=None, name=None, priority=None, profile_name=None, resource_group_name=None, subnets=None, target=None, target_resource_id=None, type=None, weight=None, __props__=None);

func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)

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

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.

The following state arguments are supported:

CustomHeaders List<EndpointCustomHeaderArgs>: One or more custom_header blocks as defined below
EndpointLocation string: 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.
EndpointMonitorStatus string
EndpointStatus string: The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.
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.
MinChildEndpoints 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 argument only applies to Endpoints of type nestedEndpoints and defaults to 1.
Name string: The name of the Traffic Manager 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.
ProfileName string: The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.
ResourceGroupName string: The name of the resource group where the Traffic Manager Profile exists.
Subnets List<EndpointSubnetArgs>: One or more subnet blocks as defined below
Target string: 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.
TargetResourceId string: The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.
Type string: The Endpoint type, must be one of: - azureEndpoints - externalEndpoints - nestedEndpoints
Weight int: 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.

CustomHeaders []EndpointCustomHeader: One or more custom_header blocks as defined below
EndpointLocation string: 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.
EndpointMonitorStatus string
EndpointStatus string: The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.
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.
MinChildEndpoints 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 argument only applies to Endpoints of type nestedEndpoints and defaults to 1.
Name string: The name of the Traffic Manager 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.
ProfileName string: The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.
ResourceGroupName string: The name of the resource group where the Traffic Manager Profile exists.
Subnets []EndpointSubnet: One or more subnet blocks as defined below
Target string: 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.
TargetResourceId string: The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.
Type string: The Endpoint type, must be one of: - azureEndpoints - externalEndpoints - nestedEndpoints
Weight int: 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.

customHeaders EndpointCustomHeader[]: One or more custom_header blocks as defined below
endpointLocation string: 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.
endpointMonitorStatus string
endpointStatus string: The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.
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.
minChildEndpoints 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 argument only applies to Endpoints of type nestedEndpoints and defaults to 1.
name string: The name of the Traffic Manager 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.
profileName string: The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.
resourceGroupName string: The name of the resource group where the Traffic Manager Profile exists.
subnets EndpointSubnet[]: One or more subnet blocks as defined below
target string: 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.
targetResourceId string: The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.
type string: The Endpoint type, must be one of: - azureEndpoints - externalEndpoints - nestedEndpoints
weight number: 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.

custom_headers List[EndpointCustomHeader]: One or more custom_header blocks as defined below
endpoint_location str: 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.
endpoint_monitor_status str
endpoint_status str: The status of the Endpoint, can be set to either Enabled or Disabled. Defaults to Enabled.
geo_mappings List[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.
min_child_endpoints float: 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.
name str: The name of the Traffic Manager endpoint. Changing this forces a new resource to be created.
priority float: 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_name str: The name of the Traffic Manager Profile to attach create the Traffic Manager endpoint.
resource_group_name str: The name of the resource group where the Traffic Manager Profile exists.
subnets List[EndpointSubnet]: One or more subnet blocks as defined below
target str: 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.
target_resource_id str: The resource id of an Azure resource to target. This argument must be provided for an endpoint of type azureEndpoints or nestedEndpoints.
type str: The Endpoint type, must be one of: - azureEndpoints - externalEndpoints - nestedEndpoints
weight float: 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.

Supporting Types

EndpointCustomHeader

See the input and output API doc for this type.

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.

EndpointSubnet

See the input and output API doc for this type.

First string: The First IP….
Last string: The Last IP…
Scope int: The Scope…

First string: The First IP….
Last string: The Last IP…
Scope int: The Scope…

first string: The First IP….
last string: The Last IP…
scope number: The Scope…

first str: The First IP….
last str: The Last IP…
scope float: The Scope…

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud