class Azure::Network::Mgmt::V2020_06_01::Models::VpnConnection

VpnConnection Resource.

Attributes

connection_bandwidth[RW]

@return [Integer] Expected bandwidth in MBPS.

connection_status[RW]

@return [VpnConnectionStatus] The connection status. Possible values include: 'Unknown', 'Connecting', 'Connected', 'NotConnected'

dpd_timeout_seconds[RW]

@return [Integer] DPD timeout in seconds for vpn connection.

egress_bytes_transferred[RW]

@return [Integer] Egress bytes transferred.

enable_bgp[RW]

@return [Boolean] EnableBgp flag.

enable_internet_security[RW]

@return [Boolean] Enable internet security.

enable_rate_limiting[RW]

@return [Boolean] EnableBgp flag.

etag[RW]

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

ingress_bytes_transferred[RW]

@return [Integer] Ingress bytes transferred.

ipsec_policies[RW]

@return [Array<IpsecPolicy>] The IPSec Policies to be considered by this connection.

name[RW]

@return [String] The name of the resource that is unique within a resource group. This name can be used to access the resource.

provisioning_state[RW]

@return [ProvisioningState] The provisioning state of the VPN connection resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

remote_vpn_site[RW]

@return [SubResource] Id of the connected vpn site.

routing_configuration[RW]

@return [RoutingConfiguration] The Routing Configuration indicating the associated and propagated route tables on this connection.

routing_weight[RW]

@return [Integer] Routing weight for vpn connection.

shared_key[RW]

@return [String] SharedKey for the vpn connection.

use_local_azure_ip_address[RW]

@return [Boolean] Use local azure ip to initiate connection.

use_policy_based_traffic_selectors[RW]

@return [Boolean] Enable policy-based traffic selectors.

vpn_connection_protocol_type[RW]

@return [VirtualNetworkGatewayConnectionProtocol] Connection protocol used for this connection. Possible values include: 'IKEv2', 'IKEv1'

Public Class Methods

mapper() click to toggle source

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

# File lib/2020-06-01/generated/azure_mgmt_network/models/vpn_connection.rb, line 89
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'
          }
        },
        dpd_timeout_seconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dpdTimeoutSeconds',
          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'
          }
        },
        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'
                }
            }
          }
        },
        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'
          }
        },
        use_local_azure_ip_address: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.useLocalAzureIpAddress',
          type: {
            name: 'Boolean'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        vpn_link_connections: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vpnLinkConnections',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'VpnSiteLinkConnectionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'VpnSiteLinkConnection'
                }
            }
          }
        },
        routing_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.routingConfiguration',
          type: {
            name: 'Composite',
            class_name: 'RoutingConfiguration'
          }
        },
        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