EndpointProperties Class

Class representing a Traffic Manager endpoint properties.

Constructor

EndpointProperties(*args: Any, **kwargs: Any)

Variables

Name Description
target_resource_id
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.

endpoint_status

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.

endpoint_location
str

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

endpoint_monitor_status

The monitoring status of the endpoint. Known values are: "CheckingEndpoint", "Online", "Degraded", "Disabled", "Inactive", "Stopped", and "Unmonitored".

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

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

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

geo_mapping

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

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.

custom_headers

List of custom headers.

always_serve

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

Attributes

always_serve

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

always_serve: str | _models.AlwaysServe | None

custom_headers

List of custom headers.

custom_headers: list['_models.EndpointPropertiesCustomHeadersItem'] | None

endpoint_location

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

endpoint_location: str | None

endpoint_monitor_status

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

endpoint_monitor_status: str | _models.EndpointMonitorStatus | None

endpoint_status

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

endpoint_status: str | _models.EndpointStatus | None

geo_mapping

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.

geo_mapping: list[str] | None

min_child_endpoints

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

min_child_endpoints: int | None

min_child_endpoints_i_pv4

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

min_child_endpoints_i_pv4: int | None

min_child_endpoints_i_pv6

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

min_child_endpoints_i_pv6: int | None

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 | None

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['_models.EndpointPropertiesSubnetsItem'] | None

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 | None

target_resource_id

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

target_resource_id: str | None

weight

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

weight: int | None