Endpoint Class

Class representing a Traffic Manager endpoint.

Constructor

Endpoint(*, id: str | None = None, name: str | None = None, type: str | None = None, target_resource_id: str | None = None, target: str | None = None, endpoint_status: str | _models.EndpointStatus | None = None, weight: int | None = None, priority: int | None = None, endpoint_location: str | None = None, endpoint_monitor_status: str | _models.EndpointMonitorStatus | None = None, min_child_endpoints: int | None = None, min_child_endpoints_i_pv4: int | None = None, min_child_endpoints_i_pv6: int | None = None, geo_mapping: List[str] | None = None, subnets: List[_models.EndpointPropertiesSubnetsItem] | None = None, custom_headers: List[_models.EndpointPropertiesCustomHeadersItem] | None = None, always_serve: str | _models.AlwaysServe | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
id	str Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}. Default value: None
name	str The name of the resource. Default value: None
type	str The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. Default value: None
target_resource_id	str The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. Default value: None
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. Default value: None
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. Known values are: "Enabled" and "Disabled". Default value: None
weight	int The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000. Default value: None
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. Default value: None
endpoint_location	str Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method. Default value: None
endpoint_monitor_status	str or EndpointMonitorStatus The monitoring status of the endpoint. Known values are: "CheckingEndpoint", "Online", "Degraded", "Disabled", "Inactive", "Stopped", and "Unmonitored". Default value: None
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'. Default value: None
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'. Default value: None
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'. Default value: None
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. Default value: None
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. Default value: None
custom_headers	list[EndpointPropertiesCustomHeadersItem] List of custom headers. Default value: None
always_serve	str or 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". Default value: None

Variables

Name	Description
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. 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	str or EndpointMonitorStatus 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	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.
always_serve	str or 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".

Feedback

Was this page helpful?