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.v2020_03_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, 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, vpn_gateway_generation: typing.Union[str, _ForwardRef('VpnGatewayGeneration'), NoneType] = None, enable_bgp: typing.Union[bool, NoneType] = None, enable_private_ip_address: 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, custom_routes: typing.Union[_ForwardRef('AddressSpace'), NoneType] = None, enable_dns_forwarding: typing.Union[bool, NoneType] = None, **kwargs)

Parameters

id

str

Resource ID.

location

str

Resource location.

tags

dict[str, str]

A set of tags. Resource tags.

ip_configurations

list[VirtualNetworkGatewayIPConfiguration]

IP configurations for virtual network gateway.

gateway_type

str or VirtualNetworkGatewayType

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

vpn_type

str or VpnType

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

vpn_gateway_generation

str or VpnGatewayGeneration

The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. Possible values include: "None", "Generation1", "Generation2".

enable_bgp

bool

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

enable_private_ip_address

bool

Whether private IP needs to be enabled on this gateway for connections or not.

active

bool

ActiveActive flag.

gateway_default_site

SubResource

The reference to 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 to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.

vpn_client_configuration

VpnClientConfiguration

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

bgp_settings

BgpSettings

Virtual network gateway's BGP speaker settings.

custom_routes

AddressSpace

The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.

enable_dns_forwarding

bool

Whether dns forwarding is enabled or not.

Variables

name

str

Resource name.

type

str

Resource type.

etag

str

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

resource_guid

str

The resource GUID property of the virtual network gateway resource.

provisioning_state

str or ProvisioningState

The provisioning state of the virtual network gateway resource. Possible values include: "Succeeded", "Updating", "Deleting", "Failed".

inbound_dns_forwarding_endpoint

str

The IP address allocated by the gateway to which dns requests can be sent.