Class: Azure::Network::Mgmt::V2018_08_01::Models::LoadBalancingRule

Inherits:
SubResource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb

Overview

A load balancing rule for a load balancer.

Instance Attribute Summary collapse

Attributes inherited from SubResource

#id

Class Method Summary collapse

Instance Attribute Details

#backend_address_pool ⇒ SubResource

randomly load balanced across IPs in the backend IPs.

Returns:

  • (SubResource) —

    A reference to a pool of DIPs. Inbound traffic is


20
21
22
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 20

def backend_address_pool
  @backend_address_pool
end

#backend_port ⇒ Integer

endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables “Any Port”

Returns:

  • (Integer) —

    The port used for internal connections on the


43
44
45
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 43

def backend_port
  @backend_port
end

#disable_outbound_snat ⇒ Boolean

use the publicIP address specified in the frontend of the load balancing rule.

Returns:

  • (Boolean) —

    Configures SNAT for the VMs in the backend pool to


65
66
67
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 65

def disable_outbound_snat
  @disable_outbound_snat
end

#enable_floating_ip ⇒ Boolean

floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

Returns:

  • (Boolean) —

    Configures a virtual machine's endpoint for the


55
56
57
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 55

def enable_floating_ip
  @enable_floating_ip
end

#enable_tcp_reset ⇒ Boolean

timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

Returns:

  • (Boolean) —

    Receive bidirectional TCP Reset on TCP flow idle


60
61
62
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 60

def enable_tcp_reset
  @enable_tcp_reset
end

#etag ⇒ String

resource is updated.

Returns:

  • (String) —

    A unique read-only string that changes whenever the


77
78
79
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 77

def etag
  @etag
end

#frontend_ipconfiguration ⇒ SubResource

Returns A reference to frontend IP addresses.

Returns:

  • (SubResource) —

    A reference to frontend IP addresses.


16
17
18
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 16

def frontend_ipconfiguration
  @frontend_ipconfiguration
end

#frontend_port ⇒ Integer

each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables “Any Port”

Returns:

  • (Integer) —

    The port for the external endpoint. Port numbers for


38
39
40
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 38

def frontend_port
  @frontend_port
end

#idle_timeout_in_minutes ⇒ Integer

can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

Returns:

  • (Integer) —

    The timeout for the TCP idle connection. The value


48
49
50
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 48

def idle_timeout_in_minutes
  @idle_timeout_in_minutes
end

#load_distribution ⇒ LoadDistribution

Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol'

Returns:


33
34
35
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 33

def load_distribution
  @load_distribution
end

#name ⇒ String

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

Returns:

  • (String) —

    The name of the resource that is unique within a


73
74
75
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 73

def name
  @name
end

#probe ⇒ SubResource

the load balancing rule.

Returns:

  • (SubResource) —

    The reference of the load balancer probe used by


24
25
26
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 24

def probe
  @probe
end

#protocol ⇒ TransportProtocol

'All'

Returns:


28
29
30
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 28

def protocol
  @protocol
end

#provisioning_state ⇒ String

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

Returns:

  • (String) —

    Gets the provisioning state of the PublicIP resource.


69
70
71
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 69

def provisioning_state
  @provisioning_state
end

Class Method Details

.mapper ⇒ Object

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


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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 84

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'LoadBalancingRule',
    type: {
      name: 'Composite',
      class_name: 'LoadBalancingRule',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        frontend_ipconfiguration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.frontendIPConfiguration',
          type: {
            name: 'Composite',
            class_name: 'SubResource'
          }
        },
        backend_address_pool: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.backendAddressPool',
          type: {
            name: 'Composite',
            class_name: 'SubResource'
          }
        },
        probe: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.probe',
          type: {
            name: 'Composite',
            class_name: 'SubResource'
          }
        },
        protocol: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.protocol',
          type: {
            name: 'String'
          }
        },
        load_distribution: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.loadDistribution',
          type: {
            name: 'String'
          }
        },
        frontend_port: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.frontendPort',
          type: {
            name: 'Number'
          }
        },
        backend_port: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.backendPort',
          type: {
            name: 'Number'
          }
        },
        idle_timeout_in_minutes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.idleTimeoutInMinutes',
          type: {
            name: 'Number'
          }
        },
        enable_floating_ip: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableFloatingIP',
          type: {
            name: 'Boolean'
          }
        },
        enable_tcp_reset: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableTcpReset',
          type: {
            name: 'Boolean'
          }
        },
        disable_outbound_snat: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.disableOutboundSnat',
          type: {
            name: 'Boolean'
          }
        },
        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'
          }
        }
      }
    }
  }
end