EndpointProperties interface

Package:

@azure/arm-privatetrafficmanager

Class representing a Traffic Manager endpoint properties.

Properties

alwaysServe	Indicates whether endpoint is Always Serve or not. Always Serve endpoints are always considered to be healthy.
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.
healthPolicyId	The health policy associated with this endpoint.
kind	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
monitoringTarget	Monitoring target is where Private Traffic Manager will gather health information.It can differ from the endpoint target, for example when the target is an IPv6 address. If not configured, the endpoint target is used. It is required when the target is IPv6 and cannot itself be an IPv6 address.
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.
provisioningState	Provisioning state of the resource.
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.
virtualNetworkIds	The virtual network ARM resource IDs assigned to this endpoint when using the 'VNet' traffic routing method. A virtual network must not be assigned to more than one endpoint in the profile. A profile can have at most one fallback endpoint; an endpoint with no virtual networks is that fallback.
weight	The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.

Property Details

alwaysServe

Indicates whether endpoint is Always Serve or not. Always Serve endpoints are always considered to be healthy.

alwaysServe?: 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

healthPolicyId

The health policy associated with this endpoint.

healthPolicyId?: string

Property Value

string

kind

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

kind?: string

Property Value

string

monitoringTarget

Monitoring target is where Private Traffic Manager will gather health information.It can differ from the endpoint target, for example when the target is an IPv6 address. If not configured, the endpoint target is used. It is required when the target is IPv6 and cannot itself be an IPv6 address.

monitoringTarget?: string

Property Value

string

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

provisioningState

Provisioning state of the resource.

provisioningState?: string

Property Value

string

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

virtualNetworkIds

The virtual network ARM resource IDs assigned to this endpoint when using the 'VNet' traffic routing method. A virtual network must not be assigned to more than one endpoint in the profile. A profile can have at most one fallback endpoint; an endpoint with no virtual networks is that fallback.

virtualNetworkIds?: 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