azure.mgmt.trafficmanager.types.EndpointProperties class

Constructor

EndpointProperties()

Variables

Name	Description
targetResourceId	str The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
target	str 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.
endpointStatus	Union[str, <xref:"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. Known values are: "Enabled" and "Disabled".
weight	int The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.
priority	int 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.
endpointLocation	str Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
endpointMonitorStatus	Union[str, <xref:"EndpointMonitorStatus">] The monitoring status of the endpoint. Known values are: "CheckingEndpoint", "Online", "Degraded", "Disabled", "Inactive", "Stopped", and "Unmonitored".
minChildEndpoints	int 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	int 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	int 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'.
geoMapping	list[str] 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.
subnets	list[<xref:"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.
customHeaders	list[<xref:"EndpointPropertiesCustomHeadersItem">] List of custom headers.
alwaysServe	Union[str, <xref:"AlwaysServe">] If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. Known values are: "Enabled" and "Disabled".

alwaysServe

If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. Known values are: "Enabled" and "Disabled".

alwaysServe: str | AlwaysServe

customHeaders

List of custom headers.

customHeaders: list['EndpointPropertiesCustomHeadersItem']

endpointLocation

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

endpointLocation: str

endpointMonitorStatus

"CheckingEndpoint", "Online", "Degraded", "Disabled", "Inactive", "Stopped", and "Unmonitored".

endpointMonitorStatus: str | EndpointMonitorStatus

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. Known values are: "Enabled" and "Disabled".

endpointStatus: str | EndpointStatus

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: list[str]

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: int

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: int

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: int

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: int

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: list['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: str

targetResourceId

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

targetResourceId: str

weight

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

weight: int