Class: Azure::Network::Mgmt::V2018_08_01::Models::VirtualNetworkGateway

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-08-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_activeBoolean

Returns ActiveActive flag.

Returns:

  • (Boolean)

    ActiveActive flag


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

def active_active
  @active_active
end

#bgp_settingsBgpSettings

Returns Virtual network gateway's BGP speaker settings.

Returns:

  • (BgpSettings)

    Virtual network gateway's BGP speaker settings.


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

def bgp_settings
  @bgp_settings
end

#enable_bgpBoolean

gateway or not.

Returns:

  • (Boolean)

    Whether BGP is enabled for this virtual network


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

def enable_bgp
  @enable_bgp
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/virtual_network_gateway.rb', line 64

def etag
  @etag
end

#gateway_default_siteSubResource

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


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

def gateway_default_site
  @gateway_default_site
end

#gateway_typeVirtualNetworkGatewayType

gateway. Possible values are: 'Vpn' and 'ExpressRoute'. Possible values include: 'Vpn', 'ExpressRoute'

Returns:


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

def gateway_type
  @gateway_type
end

#ip_configurationsArray<VirtualNetworkGatewayIPConfiguration>

for virtual network gateway.

Returns:


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

def ip_configurations
  @ip_configurations
end

#provisioning_stateString

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

Returns:

  • (String)

    The provisioning state of the VirtualNetworkGateway


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

def provisioning_state
  @provisioning_state
end

#resource_guidString

VirtualNetworkGateway resource.

Returns:

  • (String)

    The resource GUID property of the


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

def resource_guid
  @resource_guid
end

#skuVirtualNetworkGatewaySku

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

Returns:


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

def sku
  @sku
end

#vpn_client_configurationVpnClientConfiguration

VpnClientConfiguration resource which represents the P2S VpnClient configurations.

Returns:


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

def vpn_client_configuration
  @vpn_client_configuration
end

#vpn_typeVpnType

values are: 'PolicyBased' and 'RouteBased'. Possible values include: 'PolicyBased', 'RouteBased'

Returns:

  • (VpnType)

    The type of this virtual network gateway. Possible


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

def vpn_type
  @vpn_type
end

Class Method Details

.mapperObject

Mapper for VirtualNetworkGateway 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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/2018-08-01/generated/azure_mgmt_network/models/virtual_network_gateway.rb', line 71

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'
          }
        },
        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'
          }
        },
        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'
          }
        },
        etag: {
          client_side_validation: true,
          required: false,
          serialized_name: 'etag',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end