class Azure::TrafficManager::Mgmt::V2017_03_01::Models::Endpoint

Class representing a Traffic Manager endpoint.

Attributes

endpoint_location[RW]

@return [String] Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method.

endpoint_monitor_status[RW]

@return [String] Gets or sets the monitoring status of the endpoint.

endpoint_status[RW]

@return [String] 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 are 'Enabled' and 'Disabled'.

geo_mapping[RW]

@return [Array<String>] 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[RW]

@return [String] Gets or sets the ID of the Traffic Manager endpoint.

min_child_endpoints[RW]

@return [Integer] 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'.

name[RW]

@return [String] Gets or sets the name of the Traffic Manager endpoint.

priority[RW]

@return [Integer] 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.

target[RW]

@return [String] Gets or sets the fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.

target_resource_id[RW]

@return [String] Gets or sets the Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.

type[RW]

@return [String] Gets or sets the endpoint type of the Traffic Manager endpoint.

weight[RW]

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

Public Class Methods

mapper() click to toggle source

Mapper for Endpoint class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb, line 76
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Endpoint',
    type: {
      name: 'Composite',
      class_name: 'Endpoint',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        target_resource_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.targetResourceId',
          type: {
            name: 'String'
          }
        },
        target: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.target',
          type: {
            name: 'String'
          }
        },
        endpoint_status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.endpointStatus',
          type: {
            name: 'String'
          }
        },
        weight: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.weight',
          type: {
            name: 'Number'
          }
        },
        priority: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.priority',
          type: {
            name: 'Number'
          }
        },
        endpoint_location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.endpointLocation',
          type: {
            name: 'String'
          }
        },
        endpoint_monitor_status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.endpointMonitorStatus',
          type: {
            name: 'String'
          }
        },
        min_child_endpoints: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.minChildEndpoints',
          type: {
            name: 'Number'
          }
        },
        geo_mapping: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.geoMapping',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        }
      }
    }
  }
end