Class: Azure::ARM::Network::Models::LoadBalancingRule

Inherits:
MsRestAzure::SubResource
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/generated/azure_mgmt_network/models/load_balancing_rule.rb

Overview

A load balancing rule for a load balancer.

Instance Attribute Summary collapse

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



21
22
23
 
# File 'lib/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 21

def backend_address_pool
  @backend_address_pool
end

#backend_port ⇒ Integer

endpoint. Acceptable values are between 1 and 65535.

Returns:

  • (Integer) —

    The port used for internal connections on the



44
45
46
 
# File 'lib/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 44

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



61
62
63
 
# File 'lib/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 61

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



56
57
58
 
# File 'lib/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 56

def enable_floating_ip
  @enable_floating_ip
end

#etag ⇒ String

resource is updated.

Returns:

  • (String) —

    A unique read-only string that changes whenever the



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

def etag
  @etag
end

#frontend_ipconfiguration ⇒ SubResource

Returns A reference to frontend IP addresses.

Returns:

  • (SubResource) —

    A reference to frontend IP addresses.



17
18
19
 
# File 'lib/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 17

def frontend_ipconfiguration
  @frontend_ipconfiguration
end

#frontend_port ⇒ Integer

each Rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534.

Returns:

  • (Integer) —

    The port for the external endpoint. Port numbers for



40
41
42
 
# File 'lib/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 40

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



49
50
51
 
# File 'lib/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 49

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:



35
36
37
 
# File 'lib/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 35

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



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

def name
  @name
end

#probe ⇒ SubResource

the load balancing rule.

Returns:

  • (SubResource) —

    The reference of the load balancer probe used by



25
26
27
 
# File 'lib/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 25

def probe
  @probe
end

#protocol ⇒ TransportProtocol

endpoint. Possible values are ‘Udp’ or ‘Tcp’. Possible values include: ‘Udp’, ‘Tcp’

Returns:



30
31
32
 
# File 'lib/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 30

def protocol
  @protocol
end

#provisioning_state ⇒ String

Possible values are: ‘Updating’, ‘Deleting’, and ‘Failed’.

Returns:

  • (String) —

    Gets the provisioning state of the PublicIP resource.



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

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.



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/generated/azure_mgmt_network/models/load_balancing_rule.rb', line 80

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