VirtualNetworkGateway interface

Package:

@azure/arm-network-profile-2020-09-01-hybrid

A common class for general resource information

Extends

Resource

Properties

active	ActiveActive flag
bgpSettings	Virtual network gateway's BGP speaker settings.
enableBgp	Whether BGP is enabled for this virtual network gateway or not.
etag	Gets a unique read-only string that changes whenever the resource is updated.
gatewayDefaultSite	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.
gatewayType	The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.
ipConfigurations	IP configurations for virtual network gateway.
provisioningState	The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.
resourceGuid	The resource GUID property of the VirtualNetworkGateway resource.
sku	The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
vpnClientConfiguration	The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
vpnType	The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.

Inherited Properties

id	Resource ID.
location	Resource location.
name	Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

active

ActiveActive flag

active?: boolean

Property Value

boolean

bgpSettings

Virtual network gateway's BGP speaker settings.

bgpSettings?: BgpSettings

Property Value

BgpSettings

enableBgp

Whether BGP is enabled for this virtual network gateway or not.

enableBgp?: boolean

Property Value

boolean

etag

Gets a unique read-only string that changes whenever the resource is updated.

etag?: string

Property Value

string

gatewayDefaultSite

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.

gatewayDefaultSite?: SubResource

Property Value

SubResource

gatewayType

The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.

gatewayType?: string

Property Value

string

ipConfigurations

IP configurations for virtual network gateway.

ipConfigurations?: VirtualNetworkGatewayIPConfiguration[]

Property Value

VirtualNetworkGatewayIPConfiguration[]

provisioningState

The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resourceGuid

The resource GUID property of the VirtualNetworkGateway resource.

resourceGuid?: string

Property Value

string

sku

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

sku?: VirtualNetworkGatewaySku

Property Value

VirtualNetworkGatewaySku

vpnClientConfiguration

The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.

vpnClientConfiguration?: VpnClientConfiguration

Property Value

VpnClientConfiguration

vpnType

The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.

vpnType?: string

Property Value

string

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location.

location?: string

Property Value

string

Inherited From Resource.location

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type