Package version:

Interface Endpoint

Class representing a Traffic Manager endpoint.

Hierarchy

Properties

alwaysServe? customHeaders? endpointLocation? endpointMonitorStatus? endpointStatus? geoMapping? id? minChildEndpoints? minChildEndpointsIPv4? minChildEndpointsIPv6? name? priority? subnets? target? targetResourceId? type? weight?

Properties

Optional alwaysServe

alwaysServe?: string

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

Optional customHeaders

customHeaders?: EndpointPropertiesCustomHeadersItem[]

List of custom headers.

Optional endpointLocation

endpointLocation?: string

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

Optional endpointMonitorStatus

endpointMonitorStatus?: string

The monitoring status of the endpoint.

Optional endpointStatus

endpointStatus?: 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.

Optional geoMapping

geoMapping?: 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.

Optional id

id?: string

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

Optional minChildEndpoints

minChildEndpoints?: number

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

Optional minChildEndpointsIPv4

minChildEndpointsIPv4?: number

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

Optional minChildEndpointsIPv6

minChildEndpointsIPv6?: number

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

Optional name

name?: string

The name of the resource

Optional priority

priority?: number

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.

Optional subnets

subnets?: EndpointPropertiesSubnetsItem[]

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.

Optional target

target?: 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.

Optional targetResourceId

targetResourceId?: string

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

Optional type

type?: string

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

Optional weight

weight?: number

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

Settings

Member Visibility

Theme

Generated using TypeDoc