Class: Azure::TrafficManager::Mgmt::V2018_04_01::Models::MonitorConfig

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-04-01/generated/azure_mgmt_traffic_manager/models/monitor_config.rb

Overview

Class containing endpoint monitoring settings in a Traffic Manager profile.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#custom_headers ⇒ Array<MonitorConfigCustomHeadersItem>

Returns List of custom headers.

Returns:



49
50
51
 
# File 'lib/2018-04-01/generated/azure_mgmt_traffic_manager/models/monitor_config.rb', line 49

def custom_headers
  @custom_headers
end

#expected_status_code_ranges ⇒ Array<MonitorConfigExpectedStatusCodeRangesItem>

expected status code ranges.

Returns:



53
54
55
 
# File 'lib/2018-04-01/generated/azure_mgmt_traffic_manager/models/monitor_config.rb', line 53

def expected_status_code_ranges
  @expected_status_code_ranges
end

#interval_in_seconds ⇒ Integer

This is the interval at which Traffic Manager will check the health of each endpoint in this profile.

Returns:

  • (Integer) —

    The monitor interval for endpoints in this profile.



36
37
38
 
# File 'lib/2018-04-01/generated/azure_mgmt_traffic_manager/models/monitor_config.rb', line 36

def interval_in_seconds
  @interval_in_seconds
end

#path ⇒ String

probe for endpoint health.

Returns:

  • (String) —

    The path relative to the endpoint domain name used to



31
32
33
 
# File 'lib/2018-04-01/generated/azure_mgmt_traffic_manager/models/monitor_config.rb', line 31

def path
  @path
end

#port ⇒ Integer

Returns The TCP port used to probe for endpoint health.

Returns:

  • (Integer) —

    The TCP port used to probe for endpoint health.



27
28
29
 
# File 'lib/2018-04-01/generated/azure_mgmt_traffic_manager/models/monitor_config.rb', line 27

def port
  @port
end

#profile_monitor_status ⇒ ProfileMonitorStatus

the Traffic Manager profile. Possible values include: ‘CheckingEndpoints’, ‘Online’, ‘Degraded’, ‘Disabled’, ‘Inactive’

Returns:



19
20
21
 
# File 'lib/2018-04-01/generated/azure_mgmt_traffic_manager/models/monitor_config.rb', line 19

def profile_monitor_status
  @profile_monitor_status
end

#protocol ⇒ MonitorProtocol

probe for endpoint health. Possible values include: ‘HTTP’, ‘HTTPS’, ‘TCP’

Returns:



24
25
26
 
# File 'lib/2018-04-01/generated/azure_mgmt_traffic_manager/models/monitor_config.rb', line 24

def protocol
  @protocol
end

#timeout_in_seconds ⇒ Integer

This is the time that Traffic Manager allows endpoints in this profile to response to the health check.

Returns:

  • (Integer) —

    The monitor timeout for endpoints in this profile.



41
42
43
 
# File 'lib/2018-04-01/generated/azure_mgmt_traffic_manager/models/monitor_config.rb', line 41

def timeout_in_seconds
  @timeout_in_seconds
end

#tolerated_number_of_failures ⇒ Integer

Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.

Returns:

  • (Integer) —

    The number of consecutive failed health check that



46
47
48
 
# File 'lib/2018-04-01/generated/azure_mgmt_traffic_manager/models/monitor_config.rb', line 46

def tolerated_number_of_failures
  @tolerated_number_of_failures
end

Class Method Details

.mapper ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
 
# File 'lib/2018-04-01/generated/azure_mgmt_traffic_manager/models/monitor_config.rb', line 60

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'MonitorConfig',
    type: {
      name: 'Composite',
      class_name: 'MonitorConfig',
      model_properties: {
        profile_monitor_status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'profileMonitorStatus',
          type: {
            name: 'String'
          }
        },
        protocol: {
          client_side_validation: true,
          required: false,
          serialized_name: 'protocol',
          type: {
            name: 'String'
          }
        },
        port: {
          client_side_validation: true,
          required: false,
          serialized_name: 'port',
          type: {
            name: 'Number'
          }
        },
        path: {
          client_side_validation: true,
          required: false,
          serialized_name: 'path',
          type: {
            name: 'String'
          }
        },
        interval_in_seconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'intervalInSeconds',
          type: {
            name: 'Number'
          }
        },
        timeout_in_seconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'timeoutInSeconds',
          type: {
            name: 'Number'
          }
        },
        tolerated_number_of_failures: {
          client_side_validation: true,
          required: false,
          serialized_name: 'toleratedNumberOfFailures',
          type: {
            name: 'Number'
          }
        },
        custom_headers: {
          client_side_validation: true,
          required: false,
          serialized_name: 'customHeaders',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'MonitorConfigCustomHeadersItemElementType',
                type: {
                  name: 'Composite',
                  class_name: 'MonitorConfigCustomHeadersItem'
                }
            }
          }
        },
        expected_status_code_ranges: {
          client_side_validation: true,
          required: false,
          serialized_name: 'expectedStatusCodeRanges',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'MonitorConfigExpectedStatusCodeRangesItemElementType',
                type: {
                  name: 'Composite',
                  class_name: 'MonitorConfigExpectedStatusCodeRangesItem'
                }
            }
          }
        }
      }
    }
  }
end