Class: Azure::Network::Mgmt::V2018_08_01::Models::VpnConnection

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

Overview

VpnConnection Resource.

Instance Attribute Summary collapse

Attributes inherited from SubResource

#id

Class Method Summary collapse

Instance Attribute Details

#connection_bandwidthInteger

Returns Expected bandwidth in MBPS.

Returns:

  • (Integer)

    Expected bandwidth in MBPS.


36
37
38
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/vpn_connection.rb', line 36

def connection_bandwidth
  @connection_bandwidth
end

#connection_statusVpnConnectionStatus

include: 'Unknown', 'Connecting', 'Connected', 'NotConnected'

Returns:


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

def connection_status
  @connection_status
end

#egress_bytes_transferredInteger

Returns Egress bytes transferred.

Returns:

  • (Integer)

    Egress bytes transferred.


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

def egress_bytes_transferred
  @egress_bytes_transferred
end

#enable_bgpBoolean

Returns EnableBgp flag.

Returns:

  • (Boolean)

    EnableBgp flag


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

def enable_bgp
  @enable_bgp
end

#enable_internet_securityBoolean

Returns Enable internet security.

Returns:

  • (Boolean)

    Enable internet security


52
53
54
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/vpn_connection.rb', line 52

def enable_internet_security
  @enable_internet_security
end

#enable_rate_limitingBoolean

Returns EnableBgp flag.

Returns:

  • (Boolean)

    EnableBgp flag


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

def enable_rate_limiting
  @enable_rate_limiting
end

#etagString

the resource is updated.

Returns:

  • (String)

    Gets a unique read-only string that changes whenever


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

def etag
  @etag
end

#ingress_bytes_transferredInteger

Returns Ingress bytes transferred.

Returns:

  • (Integer)

    Ingress bytes transferred.


30
31
32
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/vpn_connection.rb', line 30

def ingress_bytes_transferred
  @ingress_bytes_transferred
end

#ipsec_policiesArray<IpsecPolicy>

this connection.

Returns:

  • (Array<IpsecPolicy>)

    The IPSec Policies to be considered by


46
47
48
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/vpn_connection.rb', line 46

def ipsec_policies
  @ipsec_policies
end

#nameString

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

Returns:

  • (String)

    The name of the resource that is unique within a


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

def name
  @name
end

#provisioning_stateProvisioningState

Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

Returns:


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

def provisioning_state
  @provisioning_state
end

#remote_vpn_siteSubResource

Returns Id of the connected vpn site.

Returns:


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

def remote_vpn_site
  @remote_vpn_site
end

#routing_weightInteger

Returns routing weight for vpn connection.

Returns:

  • (Integer)

    routing weight for vpn connection.


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

def routing_weight
  @routing_weight
end

#shared_keyString

Returns SharedKey for the vpn connection.

Returns:

  • (String)

    SharedKey for the vpn connection.


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

def shared_key
  @shared_key
end

#vpn_connection_protocol_typeVirtualNetworkGatewayConnectionProtocol

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

Returns:


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

def vpn_connection_protocol_type
  @vpn_connection_protocol_type
end

Class Method Details

.mapperObject

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


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
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
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/vpn_connection.rb', line 71

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'VpnConnection',
    type: {
      name: 'Composite',
      class_name: 'VpnConnection',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        remote_vpn_site: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.remoteVpnSite',
          type: {
            name: 'Composite',
            class_name: 'SubResource'
          }
        },
        routing_weight: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.routingWeight',
          type: {
            name: 'Number'
          }
        },
        connection_status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.connectionStatus',
          type: {
            name: 'String'
          }
        },
        vpn_connection_protocol_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vpnConnectionProtocolType',
          type: {
            name: 'String'
          }
        },
        ingress_bytes_transferred: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.ingressBytesTransferred',
          type: {
            name: 'Number'
          }
        },
        egress_bytes_transferred: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.egressBytesTransferred',
          type: {
            name: 'Number'
          }
        },
        connection_bandwidth: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.connectionBandwidth',
          type: {
            name: 'Number'
          }
        },
        shared_key: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.sharedKey',
          type: {
            name: 'String'
          }
        },
        enable_bgp: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableBgp',
          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'
                }
            }
          }
        },
        enable_rate_limiting: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableRateLimiting',
          type: {
            name: 'Boolean'
          }
        },
        enable_internet_security: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableInternetSecurity',
          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,
          read_only: true,
          serialized_name: 'etag',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end