class Azure::TrafficManager::Mgmt::V2018_04_01::Models::Endpoint

Class representing a Traffic Manager endpoint.

Attributes

custom_headers[RW]

@return [Array<EndpointPropertiesCustomHeadersItem>] List of custom headers.

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 [EndpointMonitorStatus] The monitoring status of the endpoint. Possible values include: 'CheckingEndpoint', 'Online', 'Degraded', 'Disabled', 'Inactive', 'Stopped'

endpoint_status[RW]

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

geo_mapping[RW]

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

min_child_endpoints[RW]

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

priority[RW]

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

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

target[RW]

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

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

weight[RW]

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

Private Class Methods

mapper() click to toggle source

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

# File lib/2018-04-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'
                }
            }
          }
        },
        subnets: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.subnets',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'EndpointPropertiesSubnetsItemElementType',
                type: {
                  name: 'Composite',
                  class_name: 'EndpointPropertiesSubnetsItem'
                }
            }
          }
        },
        custom_headers: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.customHeaders',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'EndpointPropertiesCustomHeadersItemElementType',
                type: {
                  name: 'Composite',
                  class_name: 'EndpointPropertiesCustomHeadersItem'
                }
            }
          }
        }
      }
    }
  }
end