Class: Azure::Network::Mgmt::V2019_09_01::Models::VirtualNetworkGateway

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb

Overview

A common class for general resource information.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #location, #name, #tags, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#active_active ⇒ Boolean

Returns ActiveActive flag.

Returns:

  • (Boolean) —

    ActiveActive flag.



37
38
39
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 37

def active_active
  @active_active
end

#bgp_settings ⇒ BgpSettings

Returns Virtual network gateway’s BGP speaker settings.

Returns:

  • (BgpSettings) —

    Virtual network gateway’s BGP speaker settings.



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

def bgp_settings
  @bgp_settings
end

#custom_routes ⇒ AddressSpace

which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.

Returns:

  • (AddressSpace) —

    The reference of the address space resource



60
61
62
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 60

def custom_routes
  @custom_routes
end

#enable_bgp ⇒ Boolean

gateway or not.

Returns:

  • (Boolean) —

    Whether BGP is enabled for this virtual network



34
35
36
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 34

def enable_bgp
  @enable_bgp
end

#enable_dns_forwarding ⇒ Boolean

Returns Whether dns forwarding is enabled or not.

Returns:

  • (Boolean) —

    Whether dns forwarding is enabled or not.



72
73
74
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 72

def enable_dns_forwarding
  @enable_dns_forwarding
end

#etag ⇒ String

resource is updated.

Returns:

  • (String) —

    A unique read-only string that changes whenever the



80
81
82
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 80

def etag
  @etag
end

#gateway_default_site ⇒ SubResource

which represents local network site having default routes. Assign Null value in case of removing existing default site setting.

Returns:

  • (SubResource) —

    The reference of the LocalNetworkGateway resource



42
43
44
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 42

def gateway_default_site
  @gateway_default_site
end

#gateway_type ⇒ VirtualNetworkGatewayType

gateway. Possible values include: ‘Vpn’, ‘ExpressRoute’

Returns:



21
22
23
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 21

def gateway_type
  @gateway_type
end

#inbound_dns_forwarding_endpoint ⇒ String

requests can be sent.

Returns:

  • (String) —

    The IP address allocated by the gateway to which dns



76
77
78
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 76

def inbound_dns_forwarding_endpoint
  @inbound_dns_forwarding_endpoint
end

#ip_configurations ⇒ Array<VirtualNetworkGatewayIPConfiguration>

for virtual network gateway.

Returns:



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

def ip_configurations
  @ip_configurations
end

#provisioning_state ⇒ ProvisioningState

network gateway resource. Possible values include: ‘Succeeded’, ‘Updating’, ‘Deleting’, ‘Failed’

Returns:



69
70
71
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 69

def provisioning_state
  @provisioning_state
end

#resource_guid ⇒ String

gateway resource.

Returns:

  • (String) —

    The resource GUID property of the virtual network



64
65
66
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 64

def resource_guid
  @resource_guid
end

#sku ⇒ VirtualNetworkGatewaySku

VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.

Returns:



47
48
49
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 47

def sku
  @sku
end

#vpn_client_configuration ⇒ VpnClientConfiguration

VpnClientConfiguration resource which represents the P2S VpnClient configurations.

Returns:



52
53
54
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 52

def vpn_client_configuration
  @vpn_client_configuration
end

#vpn_gateway_generation ⇒ VpnGatewayGeneration

VirtualNetworkGateway. Must be None if gatewayType is not VPN. Possible values include: ‘None’, ‘Generation1’, ‘Generation2’

Returns:



30
31
32
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 30

def vpn_gateway_generation
  @vpn_gateway_generation
end

#vpn_type ⇒ VpnType

values include: ‘PolicyBased’, ‘RouteBased’

Returns:

  • (VpnType) —

    The type of this virtual network gateway. Possible



25
26
27
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 25

def vpn_type
  @vpn_type
end

Class Method Details

.mapper ⇒ Object

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



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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 87

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'VirtualNetworkGateway',
    type: {
      name: 'Composite',
      class_name: 'VirtualNetworkGateway',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        ip_configurations: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.ipConfigurations',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'VirtualNetworkGatewayIPConfigurationElementType',
                type: {
                  name: 'Composite',
                  class_name: 'VirtualNetworkGatewayIPConfiguration'
                }
            }
          }
        },
        gateway_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.gatewayType',
          type: {
            name: 'String'
          }
        },
        vpn_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vpnType',
          type: {
            name: 'String'
          }
        },
        vpn_gateway_generation: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vpnGatewayGeneration',
          type: {
            name: 'String'
          }
        },
        enable_bgp: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableBgp',
          type: {
            name: 'Boolean'
          }
        },
        active_active: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.activeActive',
          type: {
            name: 'Boolean'
          }
        },
        gateway_default_site: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.gatewayDefaultSite',
          type: {
            name: 'Composite',
            class_name: 'SubResource'
          }
        },
        sku: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.sku',
          type: {
            name: 'Composite',
            class_name: 'VirtualNetworkGatewaySku'
          }
        },
        vpn_client_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vpnClientConfiguration',
          type: {
            name: 'Composite',
            class_name: 'VpnClientConfiguration'
          }
        },
        bgp_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.bgpSettings',
          type: {
            name: 'Composite',
            class_name: 'BgpSettings'
          }
        },
        custom_routes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.customRoutes',
          type: {
            name: 'Composite',
            class_name: 'AddressSpace'
          }
        },
        resource_guid: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceGuid',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        enable_dns_forwarding: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableDnsForwarding',
          type: {
            name: 'Boolean'
          }
        },
        inbound_dns_forwarding_endpoint: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.inboundDnsForwardingEndpoint',
          type: {
            name: 'String'
          }
        },
        etag: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'etag',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end