Class: Azure::Network::Mgmt::V2019_06_01::Models::Probe

Inherits:
SubResource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-06-01/generated/azure_mgmt_network/models/probe.rb

Overview

A load balancer probe.

Instance Attribute Summary collapse

Attributes inherited from SubResource

#id

Class Method Summary collapse

Instance Attribute Details

#etagString

resource is updated.

Returns:

  • (String)

    A unique read-only string that changes whenever the


59
60
61
# File 'lib/2019-06-01/generated/azure_mgmt_network/models/probe.rb', line 59

def etag
  @etag
end

#interval_in_secondsInteger

the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.

Returns:

  • (Integer)

    The interval, in seconds, for how frequently to probe


35
36
37
# File 'lib/2019-06-01/generated/azure_mgmt_network/models/probe.rb', line 35

def interval_in_seconds
  @interval_in_seconds
end

#load_balancing_rulesArray<SubResource>

probe.

Returns:

  • (Array<SubResource>)

    The load balancer rules that use this


17
18
19
# File 'lib/2019-06-01/generated/azure_mgmt_network/models/probe.rb', line 17

def load_balancing_rules
  @load_balancing_rules
end

#nameString

set of probes used by the load balancer. This name can be used to access the resource.

Returns:

  • (String)

    Gets name of the resource that is unique within the


55
56
57
# File 'lib/2019-06-01/generated/azure_mgmt_network/models/probe.rb', line 55

def name
  @name
end

#number_of_probesInteger

result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.

Returns:

  • (Integer)

    The number of probes where if no response, will


41
42
43
# File 'lib/2019-06-01/generated/azure_mgmt_network/models/probe.rb', line 41

def number_of_probes
  @number_of_probes
end

#portInteger

range from 1 to 65535, inclusive.

Returns:

  • (Integer)

    The port for communicating the probe. Possible values


28
29
30
# File 'lib/2019-06-01/generated/azure_mgmt_network/models/probe.rb', line 28

def port
  @port
end

#protocolProbeProtocol

specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful. Possible values include: 'Http', 'Tcp', 'Https'

Returns:


24
25
26
# File 'lib/2019-06-01/generated/azure_mgmt_network/models/probe.rb', line 24

def protocol
  @protocol
end

#provisioning_stateString

Possible values are: 'Updating', 'Deleting', and 'Failed'.

Returns:

  • (String)

    Gets the provisioning state of the public IP resource.


50
51
52
# File 'lib/2019-06-01/generated/azure_mgmt_network/models/probe.rb', line 50

def provisioning_state
  @provisioning_state
end

#request_pathString

Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.

Returns:

  • (String)

    The URI used for requesting health status from the VM.


46
47
48
# File 'lib/2019-06-01/generated/azure_mgmt_network/models/probe.rb', line 46

def request_path
  @request_path
end

#typeString

Returns Type of the resource.

Returns:

  • (String)

    Type of the resource.


62
63
64
# File 'lib/2019-06-01/generated/azure_mgmt_network/models/probe.rb', line 62

def type
  @type
end

Class Method Details

.mapperObject

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


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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/2019-06-01/generated/azure_mgmt_network/models/probe.rb', line 69

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Probe',
    type: {
      name: 'Composite',
      class_name: 'Probe',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        load_balancing_rules: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.loadBalancingRules',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'SubResourceElementType',
                type: {
                  name: 'Composite',
                  class_name: 'SubResource'
                }
            }
          }
        },
        protocol: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.protocol',
          type: {
            name: 'String'
          }
        },
        port: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.port',
          type: {
            name: 'Number'
          }
        },
        interval_in_seconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.intervalInSeconds',
          type: {
            name: 'Number'
          }
        },
        number_of_probes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.numberOfProbes',
          type: {
            name: 'Number'
          }
        },
        request_path: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.requestPath',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        etag: {
          client_side_validation: true,
          required: false,
          serialized_name: 'etag',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end