VirtualNetworkGateway Class

Definition

Namespace:: Azure.Provisioning.Network

Assembly:: Azure.Provisioning.Network.dll

Package:: Azure.Provisioning.Network v1.1.0-beta.2

Source:: VirtualNetworkGateway.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

VirtualNetworkGateway.

public class VirtualNetworkGateway : Azure.Provisioning.Primitives.ProvisionableResource

type VirtualNetworkGateway = class
    inherit ProvisionableResource

Public Class VirtualNetworkGateway
Inherits ProvisionableResource

Inheritance: Object

Provisionable

ProvisionableConstruct

NamedProvisionableConstruct

ProvisionableResource
VirtualNetworkGateway

Constructors

Name	Description
VirtualNetworkGateway(String, String)	Creates a new VirtualNetworkGateway.

Properties

Name	Description
Active	ActiveActive flag.
AdminState	Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet.
AllowRemoteVnetTraffic	Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN.
AllowVirtualWanTraffic	Configures this gateway to accept traffic from remote Virtual WAN networks.
AutoScaleBounds	The bounds of the autoscale configuration.
BgpSettings	Virtual network gateway's BGP speaker settings.
BicepIdentifier	Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisionableConstruct)
BicepMetadata	Gets the Bicep metadata for this resource, including decorators and conditions. (Inherited from ProvisionableResource)
CustomRoutes	The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
DependsOn	Declares explicit dependencies on other resources. (Inherited from ProvisionableResource)
DisableIPSecReplayProtection	disableIPSecReplayProtection flag.
EnableBgp	Whether BGP is enabled for this virtual network gateway or not.
EnableBgpRouteTranslationForNat	EnableBgpRouteTranslationForNat flag.
EnableDnsForwarding	Whether dns forwarding is enabled or not.
EnableHighBandwidthVpnGateway	To enable Advanced Connectivity feature for VPN gateway.
EnablePrivateIPAddress	Whether private IP needs to be enabled on this gateway for connections or not.
ETag	A unique read-only string that changes whenever the resource is updated.
ExtendedLocation	The extended location of type local virtual network gateway.
GatewayDefaultSiteId	Gets or sets Id.
GatewayType	The type of this virtual network gateway.
Id	Resource ID.
Identity	The identity of the virtual network gateway, if configured.
InboundDnsForwardingEndpoint	The IP address allocated by the gateway to which dns requests can be sent.
IPConfigurations	IP configurations for virtual network gateway.
IsExistingResource	Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from ProvisionableResource)
Location	Resource location.
Name	The name of the virtual network gateway.
NatRules	NatRules for virtual network gateway.
ProvisioningState	The provisioning state of the virtual network gateway resource.
ResiliencyModel	Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed.
ResourceGuid	The resource GUID property of the virtual network gateway resource.
ResourceType	Gets the type of the resource. (Inherited from ProvisionableResource)
ResourceVersion	Gets or sets the version of the resource. (Inherited from ProvisionableResource)
Sku	The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
Tags	Resource tags.
VirtualNetworkGatewayMigrationStatus	The reference to the VirtualNetworkGatewayMigrationStatus which represents the status of migration.
VirtualNetworkGatewayPolicyGroups	The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.
VNetExtendedLocationResourceId	Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.
VpnClientConfiguration	The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
VpnGatewayGeneration	The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.
VpnType	The type of this virtual network gateway.

Methods

Name	Description
AssignOrReplace<T>(T, T)	(Inherited from ProvisionableConstruct)
Build(ProvisioningBuildOptions)	Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from ProvisionableResource)
Compile()	Compile the resource into a set of Bicep statements. (Inherited from ProvisionableResource)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean)	(Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean)	(Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String)	(Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], T, Boolean, Boolean, Boolean, String)	(Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String)	(Inherited from ProvisionableConstruct)
DefineProvisionableProperties()	Define all the provisionable properties of VirtualNetworkGateway.
DefineResource<T>(String, String[], Boolean, Boolean, T)	(Inherited from ProvisionableResource)
FromExisting(String, String)	Creates a reference to an existing VirtualNetworkGateway.
GetProvisionableResources()	Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable)
Initialize()	Initialize this construct. (Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression)	(Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)	Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)	Validate the presence of any required members. (Inherited from ProvisionableResource)

Explicit Interface Implementations

Name	Description
IBicepValue.Assign(IBicepValue)	Assign a value to this property. (Inherited from ProvisionableConstruct)
IBicepValue.Compile()	Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct)
IBicepValue.Expression	Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty	Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct)
IBicepValue.IsOutput	Tracks whether this is an output only property. (Inherited from ProvisionableConstruct)
IBicepValue.IsRequired	Tracks whether this property is required. (Inherited from ProvisionableConstruct)
IBicepValue.IsSecure	Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct)
IBicepValue.Kind	Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue	Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct)
IBicepValue.Self	Gets information about where this value was defined. (Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()	Make this value readonly. (Inherited from ProvisionableConstruct)
IBicepValue.Source	Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct)

Extension Methods

Name	Description
ToBicepExpression(IBicepValue)	Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy.

Applies to

Feedback

Was this page helpful?