Class: Azure::Network::Mgmt::V2016_06_01::Models::Probe

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

Overview

Load balancer Probe

Instance Attribute Summary collapse

Attributes inherited from SubResource

#id

Class Method Summary collapse

Instance Attribute Details

#etag ⇒ String

resource is updated

Returns:

  • (String) —

    A unique read-only string that changes whenever the



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

def etag
  @etag
end

#interval_in_seconds ⇒ Integer

frequently to probe 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) —

    Gets or sets the interval, in seconds, for how



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

def interval_in_seconds
  @interval_in_seconds
end

#load_balancing_rules ⇒ Array<SubResource>

probe

Returns:

  • (Array<SubResource>) —

    Gets Load balancer rules that use this



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

def load_balancing_rules
  @load_balancing_rules
end

#name ⇒ String

resource group. This name can be used to access the resource

Returns:

  • (String) —

    Gets name of the resource that is unique within a



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

def name
  @name
end

#number_of_probes ⇒ Integer

response, will 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) —

    Gets or sets the number of probes where if no



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

def number_of_probes
  @number_of_probes
end

#port ⇒ Integer

Possible values range from 1 to 65535, inclusive.

Returns:

  • (Integer) —

    Gets or sets Port for communicating the probe.



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

def port
  @port
end

#protocol ⇒ ProbeProtocol

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

Returns:

  • (ProbeProtocol) —

    Gets or sets the protocol of the end point.



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

def protocol
  @protocol
end

#provisioning_state ⇒ String

Updating/Deleting/Failed

Returns:

  • (String) —

    Gets provisioning state of the PublicIP resource



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

def provisioning_state
  @provisioning_state
end

#request_path ⇒ String

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

Returns:

  • (String) —

    Gets or sets the URI used for requesting health status



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

def request_path
  @request_path
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2016-06-01/generated/azure_mgmt_network/models/probe.rb', line 65

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