Watch Aspire live streamsDocsTry Aspire

VirtualNetworkGatewayConnectionProxy

Handle
📦 Aspire.Hosting.Azure.Provisioning.Network v13.6.0-preview.1.26478.8
interface VirtualNetworkGatewayConnectionProxy {
authenticationType: BicepValueProxy | ConnectionAuthenticationType;
authorizationKey: BicepValueProxy | string;
certificateAuthentication: CertificateAuthenticationProxy;
connectionMode: BicepValueProxy | VirtualNetworkGatewayConnectionMode;
connectionProtocol: BicepValueProxy | VirtualNetworkGatewayConnectionProtocol;
readonly connectionStatus: BicepValueProxy | VirtualNetworkGatewayConnectionStatus;
connectionType: BicepValueProxy | VirtualNetworkGatewayConnectionType;
dpdTimeoutSeconds: BicepValueProxy | number;
readonly egressBytesTransferred: BicepValueProxy | number;
egressNatRules: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfWritableSubResourceProxy;
enableBgp: BicepValueProxy | boolean;
enablePrivateLinkFastPath: BicepValueProxy | boolean;
readonly eTag: BicepValueProxy;
expressRouteGatewayBypass: BicepValueProxy | boolean;
gatewayCustomBgpIPAddresses: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfGatewayCustomBgpIPAddressIPConfigurationProxy;
readonly id: BicepValueProxy;
readonly ingressBytesTransferred: BicepValueProxy | number;
ingressNatRules: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfWritableSubResourceProxy;
iPsecPolicies: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfIPsecPolicyProxy;
localNetworkGateway2: LocalNetworkGatewayProxy;
location: BicepValueProxy;
name: BicepValueProxy | string;
peerId: BicepValueProxy;
readonly provisioningState: BicepValueProxy | NetworkProvisioningState;
readonly resourceGuid: BicepValueProxy | guid;
routingWeight: BicepValueProxy | number;
sharedKey: BicepValueProxy | string;
tags: Aspire_Hosting_Azure_Provisioning_Network_Generated_DictionaryOfStringProxy;
trafficSelectorPolicies: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfTrafficSelectorPolicyProxy;
readonly tunnelConnectionStatus: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfTunnelConnectionHealthProxy;
tunnelProperties: Aspire_Hosting_Azure_Provisioning_Network_Generated_ListOfVirtualNetworkGatewayConnectionTunnelPropertiesProxy;
useLocalAzureIPAddress: BicepValueProxy | boolean;
usePolicyBasedTrafficSelectors: BicepValueProxy | boolean;
virtualNetworkGateway1: VirtualNetworkGatewayProxy;
virtualNetworkGateway2: VirtualNetworkGatewayProxy;
addTo(infrastructure: AzureResourceInfrastructure): void;
clearAuthenticationType(): void;
clearAuthorizationKey(): void;
clearConnectionMode(): void;
clearConnectionProtocol(): void;
clearConnectionType(): void;
clearDpdTimeoutSeconds(): void;
clearEnableBgp(): void;
clearEnablePrivateLinkFastPath(): void;
clearExpressRouteGatewayBypass(): void;
clearLocation(): void;
clearName(): void;
clearPeerId(): void;
clearRoutingWeight(): void;
clearSharedKey(): void;
clearUseLocalAzureIPAddress(): void;
clearUsePolicyBasedTrafficSelectors(): void;
}

Properties

propertyauthenticationTypeBicepValueProxy | ConnectionAuthenticationTypeget · set
Gets or sets the AuthenticationType provisioning property.
propertyauthorizationKeyBicepValueProxy | stringget · set
Gets or sets the AuthorizationKey provisioning property.
propertycertificateAuthenticationCertificateAuthenticationProxyget · set
Gets or sets the CertificateAuthentication provisioning property.
propertyconnectionModeBicepValueProxy | VirtualNetworkGatewayConnectionModeget · set
Gets or sets the ConnectionMode provisioning property.
propertyconnectionProtocolBicepValueProxy | VirtualNetworkGatewayConnectionProtocolget · set
Gets or sets the ConnectionProtocol provisioning property.
propertyconnectionStatusBicepValueProxy | VirtualNetworkGatewayConnectionStatusget
Gets the ConnectionStatus provisioning property.
propertyconnectionTypeBicepValueProxy | VirtualNetworkGatewayConnectionTypeget · set
Gets or sets the ConnectionType provisioning property.
propertydpdTimeoutSecondsBicepValueProxy | numberget · set
Gets or sets the DpdTimeoutSeconds provisioning property.
propertyegressBytesTransferredBicepValueProxy | numberget
Gets the EgressBytesTransferred provisioning property.
propertyegressNatRulesAspire_Hosting_Azure_Provisioning_Network_Generated_ListOfWritableSubResourceProxyget · set
Gets or sets the EgressNatRules provisioning property.
propertyenableBgpBicepValueProxy | booleanget · set
Gets or sets the EnableBgp provisioning property.
propertyenablePrivateLinkFastPathBicepValueProxy | booleanget · set
Gets or sets the EnablePrivateLinkFastPath provisioning property.
propertyeTagBicepValueProxyget
Gets the ETag provisioning property.
propertyexpressRouteGatewayBypassBicepValueProxy | booleanget · set
Gets or sets the ExpressRouteGatewayBypass provisioning property.
propertygatewayCustomBgpIPAddressesAspire_Hosting_Azure_Provisioning_Network_Generated_ListOfGatewayCustomBgpIPAddressIPConfigurationProxyget · set
Gets or sets the GatewayCustomBgpIPAddresses provisioning property.
propertyidBicepValueProxyget
Gets the Id provisioning property.
propertyingressBytesTransferredBicepValueProxy | numberget
Gets the IngressBytesTransferred provisioning property.
propertyingressNatRulesAspire_Hosting_Azure_Provisioning_Network_Generated_ListOfWritableSubResourceProxyget · set
Gets or sets the IngressNatRules provisioning property.
propertyiPsecPoliciesAspire_Hosting_Azure_Provisioning_Network_Generated_ListOfIPsecPolicyProxyget · set
Gets or sets the IPsecPolicies provisioning property.
propertylocalNetworkGateway2LocalNetworkGatewayProxyget · set
Gets or sets the LocalNetworkGateway2 provisioning property.
propertylocationBicepValueProxyget · set
Gets or sets the Location provisioning property.
propertynameBicepValueProxy | stringget · set
Gets or sets the Name provisioning property.
propertypeerIdBicepValueProxyget · set
Gets or sets the PeerId provisioning property.
propertyprovisioningStateBicepValueProxy | NetworkProvisioningStateget
Gets the ProvisioningState provisioning property.
propertyresourceGuidBicepValueProxy | guidget
Gets the ResourceGuid provisioning property.
propertyroutingWeightBicepValueProxy | numberget · set
Gets or sets the RoutingWeight provisioning property.
propertysharedKeyBicepValueProxy | stringget · set
Gets or sets the SharedKey provisioning property.
propertytagsAspire_Hosting_Azure_Provisioning_Network_Generated_DictionaryOfStringProxyget · set
Gets or sets the Tags provisioning property.
propertytrafficSelectorPoliciesAspire_Hosting_Azure_Provisioning_Network_Generated_ListOfTrafficSelectorPolicyProxyget · set
Gets or sets the TrafficSelectorPolicies provisioning property.
propertytunnelConnectionStatusAspire_Hosting_Azure_Provisioning_Network_Generated_ListOfTunnelConnectionHealthProxyget
Gets the TunnelConnectionStatus provisioning property.
propertytunnelPropertiesAspire_Hosting_Azure_Provisioning_Network_Generated_ListOfVirtualNetworkGatewayConnectionTunnelPropertiesProxyget · set
Gets or sets the TunnelProperties provisioning property.
propertyuseLocalAzureIPAddressBicepValueProxy | booleanget · set
Gets or sets the UseLocalAzureIPAddress provisioning property.
propertyusePolicyBasedTrafficSelectorsBicepValueProxy | booleanget · set
Gets or sets the UsePolicyBasedTrafficSelectors provisioning property.
propertyvirtualNetworkGateway1VirtualNetworkGatewayProxyget · set
Gets or sets the VirtualNetworkGateway1 provisioning property.
propertyvirtualNetworkGateway2VirtualNetworkGatewayProxyget · set
Gets or sets the VirtualNetworkGateway2 provisioning property.

Methods

methodaddTo
Adds this provisioning resource to the Azure resource infrastructure.
addTo(infrastructure: AzureResourceInfrastructure): void
infrastructureAzureResourceInfrastructure
Clears the AuthenticationType provisioning property.
clearAuthenticationType(): void
Clears the AuthorizationKey provisioning property.
clearAuthorizationKey(): void
Clears the ConnectionMode provisioning property.
clearConnectionMode(): void
Clears the ConnectionProtocol provisioning property.
clearConnectionProtocol(): void
Clears the ConnectionType provisioning property.
clearConnectionType(): void
Clears the DpdTimeoutSeconds provisioning property.
clearDpdTimeoutSeconds(): void
Clears the EnableBgp provisioning property.
clearEnableBgp(): void
Clears the EnablePrivateLinkFastPath provisioning property.
clearEnablePrivateLinkFastPath(): void
Clears the ExpressRouteGatewayBypass provisioning property.
clearExpressRouteGatewayBypass(): void
Clears the Location provisioning property.
clearLocation(): void
methodclearName
Clears the Name provisioning property.
clearName(): void
Clears the PeerId provisioning property.
clearPeerId(): void
Clears the RoutingWeight provisioning property.
clearRoutingWeight(): void
Clears the SharedKey provisioning property.
clearSharedKey(): void
Clears the UseLocalAzureIPAddress provisioning property.
clearUseLocalAzureIPAddress(): void
Clears the UsePolicyBasedTrafficSelectors provisioning property.
clearUsePolicyBasedTrafficSelectors(): void