Share via


Endpoint Class

Definition

Class representing a Traffic Manager endpoint.

[Microsoft.Rest.Serialization.JsonTransformation]
public class Endpoint : Microsoft.Azure.Management.TrafficManager.Models.ProxyResource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type Endpoint = class
    inherit ProxyResource
Public Class Endpoint
Inherits ProxyResource
Inheritance
Attributes

Constructors

Endpoint()

Initializes a new instance of the Endpoint class.

Endpoint(String, String, String, String, String, Nullable<EndpointStatus>, Nullable<Int64>, Nullable<Int64>, String, Nullable<EndpointMonitorStatus>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, IList<String>, IList<EndpointPropertiesSubnetsItem>, IList<EndpointPropertiesCustomHeadersItem>)

Initializes a new instance of the Endpoint class.

Properties

CustomHeaders

Gets or sets list of custom headers.

EndpointLocation

Gets or sets specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.

EndpointMonitorStatus

Gets or sets the monitoring status of the endpoint. Possible values include: 'CheckingEndpoint', 'Online', 'Degraded', 'Disabled', 'Inactive', 'Stopped'

EndpointStatus

Gets or sets 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'

GeoMapping

Gets or sets 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.

Id

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

(Inherited from Resource)
MinChildEndpoints

Gets or sets 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

Gets or sets 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

Gets or sets 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'.

Name

Gets or sets the name of the resource

(Inherited from Resource)
Priority

Gets or sets 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.

Subnets

Gets or sets 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.

Target

Gets or sets 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.

TargetResourceId

Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.

Type

Gets or sets the type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

(Inherited from Resource)
Weight

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

Applies to