Share via


VirtualNetworkGatewayConnection Class

Definition

VirtualNetworkGatewayConnection.

public class VirtualNetworkGatewayConnection : Azure.Provisioning.Primitives.ProvisionableResource
type VirtualNetworkGatewayConnection = class
    inherit ProvisionableResource
Public Class VirtualNetworkGatewayConnection
Inherits ProvisionableResource
Inheritance

Constructors

Name Description
VirtualNetworkGatewayConnection(String, String)

Creates a new VirtualNetworkGatewayConnection.

Properties

Name Description
AuthenticationType

Gateway connection authentication type.

AuthorizationKey

The authorizationKey.

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)
CertificateAuthentication

Certificate Authentication information for a certificate based authentication connection.

ConnectionMode

The connection mode for this connection.

ConnectionProtocol

Connection protocol used for this connection.

ConnectionStatus

Virtual Network Gateway connection status.

ConnectionType

Gateway connection type.

DependsOn

Declares explicit dependencies on other resources.

(Inherited from ProvisionableResource)
DpdTimeoutSeconds

The dead peer detection timeout of this connection in seconds.

EgressBytesTransferred

The egress bytes transferred in this connection.

EgressNatRules

List of egress NatRules.

EnableBgp

EnableBgp flag.

EnablePrivateLinkFastPath

Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.

ETag

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

ExpressRouteGatewayBypass

Bypass ExpressRoute Gateway for data forwarding.

GatewayCustomBgpIPAddresses

GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.

Id

Resource ID.

IngressBytesTransferred

The ingress bytes transferred in this connection.

IngressNatRules

List of ingress NatRules.

IPsecPolicies

The IPSec Policies to be considered by this connection.

IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from ProvisionableResource)
LocalNetworkGateway2

The reference to local network gateway resource.

Location

Resource location.

Name

The name of the virtual network gateway connection.

PeerId

Gets or sets Id.

ProvisioningState

The provisioning state of the virtual network gateway connection resource.

ResourceGuid

The resource GUID property of the virtual network gateway connection resource.

ResourceType

Gets the type of the resource.

(Inherited from ProvisionableResource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from ProvisionableResource)
RoutingWeight

The routing weight.

SharedKey

The IPSec shared key.

Tags

Resource tags.

TrafficSelectorPolicies

The Traffic Selector Policies to be considered by this connection.

TunnelConnectionStatus

Collection of all tunnels' connection health status.

TunnelProperties

Tunnel properties for virtual network gateway connection.

UseLocalAzureIPAddress

Use private local Azure IP for the connection.

UsePolicyBasedTrafficSelectors

Enable policy-based traffic selectors.

VirtualNetworkGateway1

The reference to virtual network gateway resource.

VirtualNetworkGateway2

The reference to virtual network gateway resource.

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 VirtualNetworkGatewayConnection.

DefineResource<T>(String, String[], Boolean, Boolean, T) (Inherited from ProvisionableResource)
FromExisting(String, String)

Creates a reference to an existing VirtualNetworkGatewayConnection.

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