Class: Azure::Network::Mgmt::V2018_08_01::Models::VirtualNetworkGatewayConnection

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-08-01/generated/azure_mgmt_network/models/virtual_network_gateway_connection.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

#authorization_keyString

Returns The authorizationKey.

Returns:

  • (String)

    The authorizationKey.


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

def authorization_key
  @authorization_key
end

#connection_protocolVirtualNetworkGatewayConnectionProtocol

used for this connection. Possible values include: 'IKEv2', 'IKEv1'

Returns:


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

def connection_protocol
  @connection_protocol
end

#connection_statusVirtualNetworkGatewayConnectionStatus

connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected'

Returns:


50
51
52
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/virtual_network_gateway_connection.rb', line 50

def connection_status
  @connection_status
end

#connection_typeVirtualNetworkGatewayConnectionType

Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible values include: 'IPsec', 'Vnet2Vnet', 'ExpressRoute', 'VPNClient'

Returns:


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

def connection_type
  @connection_type
end

#egress_bytes_transferredInteger

Returns The egress bytes transferred in this connection.

Returns:

  • (Integer)

    The egress bytes transferred in this connection.


57
58
59
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/virtual_network_gateway_connection.rb', line 57

def egress_bytes_transferred
  @egress_bytes_transferred
end

#enable_bgpBoolean

Returns EnableBgp flag.

Returns:

  • (Boolean)

    EnableBgp flag


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

def enable_bgp
  @enable_bgp
end

#etagString

the resource is updated.

Returns:

  • (String)

    Gets a unique read-only string that changes whenever


89
90
91
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/virtual_network_gateway_connection.rb', line 89

def etag
  @etag
end

#express_route_gateway_bypassBoolean

Returns Bypass ExpressRoute Gateway for data forwarding.

Returns:

  • (Boolean)

    Bypass ExpressRoute Gateway for data forwarding


85
86
87
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/virtual_network_gateway_connection.rb', line 85

def express_route_gateway_bypass
  @express_route_gateway_bypass
end

#ingress_bytes_transferredInteger

Returns The ingress bytes transferred in this connection.

Returns:

  • (Integer)

    The ingress bytes transferred in this connection.


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

def ingress_bytes_transferred
  @ingress_bytes_transferred
end

#ipsec_policiesArray<IpsecPolicy>

this connection.

Returns:

  • (Array<IpsecPolicy>)

    The IPSec Policies to be considered by


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

def ipsec_policies
  @ipsec_policies
end

#local_network_gateway2LocalNetworkGateway

resource.

Returns:


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

def local_network_gateway2
  @local_network_gateway2
end

#peerSubResource

Returns The reference to peerings resource.

Returns:

  • (SubResource)

    The reference to peerings resource.


63
64
65
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/virtual_network_gateway_connection.rb', line 63

def peer
  @peer
end

#provisioning_stateString

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

Returns:

  • (String)

    The provisioning state of the


82
83
84
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/virtual_network_gateway_connection.rb', line 82

def provisioning_state
  @provisioning_state
end

#resource_guidString

VirtualNetworkGatewayConnection resource.

Returns:

  • (String)

    The resource GUID property of the


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

def resource_guid
  @resource_guid
end

#routing_weightInteger

Returns The routing weight.

Returns:

  • (Integer)

    The routing weight.


41
42
43
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/virtual_network_gateway_connection.rb', line 41

def routing_weight
  @routing_weight
end

#shared_keyString

Returns The IPSec shared key.

Returns:

  • (String)

    The IPSec shared key.


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

def shared_key
  @shared_key
end

#tunnel_connection_statusArray<TunnelConnectionHealth>

connection health status.

Returns:


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

def tunnel_connection_status
  @tunnel_connection_status
end

#use_policy_based_traffic_selectorsBoolean

Returns Enable policy-based traffic selectors.

Returns:

  • (Boolean)

    Enable policy-based traffic selectors.


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

def use_policy_based_traffic_selectors
  @use_policy_based_traffic_selectors
end

#virtual_network_gateway1VirtualNetworkGateway

gateway resource.

Returns:


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

def virtual_network_gateway1
  @virtual_network_gateway1
end

#virtual_network_gateway2VirtualNetworkGateway

gateway resource.

Returns:


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

def virtual_network_gateway2
  @virtual_network_gateway2
end

Class Method Details

.mapperObject

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


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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/virtual_network_gateway_connection.rb', line 96

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'VirtualNetworkGatewayConnection',
    type: {
      name: 'Composite',
      class_name: 'VirtualNetworkGatewayConnection',
      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'
                }
            }
          }
        },
        authorization_key: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.authorizationKey',
          type: {
            name: 'String'
          }
        },
        virtual_network_gateway1: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.virtualNetworkGateway1',
          type: {
            name: 'Composite',
            class_name: 'VirtualNetworkGateway'
          }
        },
        virtual_network_gateway2: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.virtualNetworkGateway2',
          type: {
            name: 'Composite',
            class_name: 'VirtualNetworkGateway'
          }
        },
        local_network_gateway2: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.localNetworkGateway2',
          type: {
            name: 'Composite',
            class_name: 'LocalNetworkGateway'
          }
        },
        connection_type: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.connectionType',
          type: {
            name: 'String'
          }
        },
        connection_protocol: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.connectionProtocol',
          type: {
            name: 'String'
          }
        },
        routing_weight: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.routingWeight',
          type: {
            name: 'Number'
          }
        },
        shared_key: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.sharedKey',
          type: {
            name: 'String'
          }
        },
        connection_status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.connectionStatus',
          type: {
            name: 'String'
          }
        },
        tunnel_connection_status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.tunnelConnectionStatus',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'TunnelConnectionHealthElementType',
                type: {
                  name: 'Composite',
                  class_name: 'TunnelConnectionHealth'
                }
            }
          }
        },
        egress_bytes_transferred: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.egressBytesTransferred',
          type: {
            name: 'Number'
          }
        },
        ingress_bytes_transferred: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.ingressBytesTransferred',
          type: {
            name: 'Number'
          }
        },
        peer: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.peer',
          type: {
            name: 'Composite',
            class_name: 'SubResource'
          }
        },
        enable_bgp: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableBgp',
          type: {
            name: 'Boolean'
          }
        },
        use_policy_based_traffic_selectors: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.usePolicyBasedTrafficSelectors',
          type: {
            name: 'Boolean'
          }
        },
        ipsec_policies: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.ipsecPolicies',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'IpsecPolicyElementType',
                type: {
                  name: 'Composite',
                  class_name: 'IpsecPolicy'
                }
            }
          }
        },
        resource_guid: {
          client_side_validation: true,
          required: false,
          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'
          }
        },
        express_route_gateway_bypass: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.expressRouteGatewayBypass',
          type: {
            name: 'Boolean'
          }
        },
        etag: {
          client_side_validation: true,
          required: false,
          serialized_name: 'etag',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end