class Azure::Network::Mgmt::V2017_09_01::Models::VirtualNetworkGateway

A common class for general resource information

Attributes

active_active[RW]

@return [Boolean] ActiveActive flag

bgp_settings[RW]

@return [BgpSettings] Virtual network gateway's BGP speaker settings.

enable_bgp[RW]

@return [Boolean] Whether BGP is enabled for this virtual network gateway or not.

etag[RW]

@return [String] Gets a unique read-only string that changes whenever the resource is updated.

gateway_default_site[RW]

@return [SubResource] The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.

gateway_type[RW]

@return [VirtualNetworkGatewayType] The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. Possible values include: 'Vpn', 'ExpressRoute'

ip_configurations[RW]

@return [Array<VirtualNetworkGatewayIPConfiguration>] IP configurations for virtual network gateway.

provisioning_state[RW]

@return [String] The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

resource_guid[RW]

@return [String] The resource GUID property of the VirtualNetworkGateway resource.

sku[RW]

@return [VirtualNetworkGatewaySku] The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.

vpn_client_configuration[RW]

@return [VpnClientConfiguration] The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.

vpn_type[RW]

@return [VpnType] The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. Possible values include: 'PolicyBased', 'RouteBased'

Public Class Methods

mapper() click to toggle source

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

# File lib/2017-09-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