Endpoint Class

Class representing a Traffic Manager endpoint.

Inheritance

azure.mgmt.trafficmanager.models._models_py3.ProxyResource

Endpoint

Constructor

Endpoint(*, id: Optional[str] = None, name: Optional[str] = None, type: Optional[str] = None, target_resource_id: Optional[str] = None, target: Optional[str] = None, endpoint_status: Optional[Union[str, azure.mgmt.trafficmanager.models._traffic_manager_management_client_enums.EndpointStatus]] = None, weight: Optional[int] = None, priority: Optional[int] = None, endpoint_location: Optional[str] = None, endpoint_monitor_status: Optional[Union[str, azure.mgmt.trafficmanager.models._traffic_manager_management_client_enums.EndpointMonitorStatus]] = None, min_child_endpoints: Optional[int] = None, min_child_endpoints_i_pv4: Optional[int] = None, min_child_endpoints_i_pv6: Optional[int] = None, geo_mapping: Optional[List[str]] = None, subnets: Optional[List[azure.mgmt.trafficmanager.models._models_py3.EndpointPropertiesSubnetsItem]] = None, custom_headers: Optional[List[azure.mgmt.trafficmanager.models._models_py3.EndpointPropertiesCustomHeadersItem]] = None, **kwargs)

Variables

id

str

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

name

str

The name of the resource.

type

str

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

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

str or 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. Possible values include: "Enabled", "Disabled".

weight

<xref:long>

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

priority

<xref:long>

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

str or EndpointMonitorStatus

The monitoring status of the endpoint. Possible values include: "CheckingEndpoint", "Online", "Degraded", "Disabled", "Inactive", "Stopped".

min_child_endpoints

<xref:long>

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

<xref:long>

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

<xref:long>

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

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

custom_headers

list[EndpointPropertiesCustomHeadersItem]

List of custom headers.