Share via

Endpoint interface

  • Reference
Package:
@azure/arm-trafficmanager

Class representing a Traffic Manager endpoint.

Extends
ProxyResource

Properties

alwaysServe

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

List of custom headers.
endpointLocation

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

The monitoring status of the endpoint.
endpointStatus

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

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.
minChildEndpoints

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

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

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'.
priority

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.
subnets

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

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

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

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

Inherited Properties

id

Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name

The name of the resource
type

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

Property Details

alwaysServe

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

alwaysServe?: string

Property Value

string

customHeaders

List of custom headers.

customHeaders?: EndpointPropertiesCustomHeadersItem[]

Property Value

EndpointPropertiesCustomHeadersItem[]

endpointLocation

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

endpointLocation?: string

Property Value

string

endpointMonitorStatus

The monitoring status of the endpoint.

endpointMonitorStatus?: string

Property Value

string

endpointStatus

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

endpointStatus?: string

Property Value

string

geoMapping

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.

geoMapping?: string[]

Property Value

string[]

minChildEndpoints

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'.

minChildEndpoints?: number

Property Value

number

minChildEndpointsIPv4

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'.

minChildEndpointsIPv4?: number

Property Value

number

minChildEndpointsIPv6

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'.

minChildEndpointsIPv6?: number

Property Value

number

priority

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.

priority?: number

Property Value

number

subnets

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.

subnets?: EndpointPropertiesSubnetsItem[]

Property Value

EndpointPropertiesSubnetsItem[]

target

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.

target?: string

Property Value

string

targetResourceId

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

targetResourceId?: string

Property Value

string

weight

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

weight?: number

Property Value

number

Inherited Property Details

id

Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

type

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

type?: string

Property Value

string

Inherited From ProxyResource.type