Class: Azure::TrafficManager::Mgmt::V2017_03_01::Models::Endpoint

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb

Overview

Class representing a Traffic Manager endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#endpoint_location ⇒ String

endpoints when using the ‘Performance’ traffic routing method.

Returns:

  • (String) —

    Specifies the location of the external or nested



54
55
56
 
# File 'lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb', line 54

def endpoint_location
  @endpoint_location
end

#endpoint_monitor_status ⇒ String

Returns Gets or sets the monitoring status of the endpoint.

Returns:

  • (String) —

    Gets or sets the monitoring status of the endpoint.



57
58
59
 
# File 'lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb', line 57

def endpoint_monitor_status
  @endpoint_monitor_status
end

#endpoint_status ⇒ String

endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. Possible values are ‘Enabled’ and ‘Disabled’.

Returns:

  • (String) —

    Gets or sets the status of the endpoint.. If the



38
39
40
 
# File 'lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb', line 38

def endpoint_status
  @endpoint_status
end

#geo_mapping ⇒ Array<String>

mapped to this endpoint when using the ‘Geographic’ traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values.

Returns:

  • (Array<String>) —

    Gets or sets the list of countries/regions



69
70
71
 
# File 'lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb', line 69

def geo_mapping
  @geo_mapping
end

#id ⇒ String

Returns Gets or sets the ID of the Traffic Manager endpoint.

Returns:

  • (String) —

    Gets or sets the ID of the Traffic Manager endpoint.



16
17
18
 
# File 'lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb', line 16

def id
  @id
end

#min_child_endpoints ⇒ Integer

must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’.

Returns:

  • (Integer) —

    Gets or sets the minimum number of endpoints that



63
64
65
 
# File 'lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb', line 63

def min_child_endpoints
  @min_child_endpoints
end

#name ⇒ String

Returns Gets or sets the name of the Traffic Manager endpoint.

Returns:

  • (String) —

    Gets or sets the name of the Traffic Manager endpoint.



19
20
21
 
# File 'lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb', line 19

def name
  @name
end

#priority ⇒ Integer

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.

Returns:

  • (Integer) —

    Gets or sets the priority of this endpoint when using



50
51
52
 
# File 'lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb', line 50

def priority
  @priority
end

#target ⇒ String

endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.

Returns:

  • (String) —

    Gets or sets the fully-qualified DNS name of the



32
33
34
 
# File 'lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb', line 32

def target
  @target
end

#target_resource_id ⇒ String

endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’.

Returns:

  • (String) —

    Gets or sets the Azure Resource URI of the of the



27
28
29
 
# File 'lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb', line 27

def target_resource_id
  @target_resource_id
end

#type ⇒ String

endpoint.

Returns:

  • (String) —

    Gets or sets the endpoint type of the Traffic Manager



23
24
25
 
# File 'lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb', line 23

def type
  @type
end

#weight ⇒ Integer

the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000.

Returns:

  • (Integer) —

    Gets or sets the weight of this endpoint when using



43
44
45
 
# File 'lib/2017-03-01/generated/azure_mgmt_traffic_manager/models/endpoint.rb', line 43

def weight
  @weight
end

Class Method Details

.mapper ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# 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