VirtualNetworkGateway Class

A common class for general resource information.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.network.v2018_07_01.models._models_py3.Resource

VirtualNetworkGateway

Constructor

VirtualNetworkGateway(*, id: typing.Union[str, NoneType] = None, location: typing.Union[str, NoneType] = None, tags: typing.Union[typing.Dict[str, str], NoneType] = None, etag: typing.Union[str, NoneType] = None, ip_configurations: typing.Union[typing.List[_ForwardRef('VirtualNetworkGatewayIPConfiguration')], NoneType] = None, gateway_type: typing.Union[str, _ForwardRef('VirtualNetworkGatewayType'), NoneType] = None, vpn_type: typing.Union[str, _ForwardRef('VpnType'), NoneType] = None, enable_bgp: typing.Union[bool, NoneType] = None, active: typing.Union[bool, NoneType] = None, gateway_default_site: typing.Union[_ForwardRef('SubResource'), NoneType] = None, sku: typing.Union[_ForwardRef('VirtualNetworkGatewaySku'), NoneType] = None, vpn_client_configuration: typing.Union[_ForwardRef('VpnClientConfiguration'), NoneType] = None, bgp_settings: typing.Union[_ForwardRef('BgpSettings'), NoneType] = None, resource_guid: typing.Union[str, NoneType] = None, **kwargs)

Parameters

id

str

Resource ID.

location

str

Resource location.

tags

dict[str, str]

A set of tags. Resource tags.

etag

str

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

ip_configurations

list[VirtualNetworkGatewayIPConfiguration]

IP configurations for virtual network gateway.

gateway_type

str or VirtualNetworkGatewayType

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

vpn_type

str or VpnType

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

enable_bgp

bool

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

active

bool

ActiveActive flag.

gateway_default_site

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.

sku

VirtualNetworkGatewaySku

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

vpn_client_configuration

VpnClientConfiguration

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

bgp_settings

BgpSettings

Virtual network gateway's BGP speaker settings.

resource_guid

str

The resource GUID property of the VirtualNetworkGateway resource.

Variables

name

str

Resource name.

type

str

Resource type.

provisioning_state

str

The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.