Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getVpnGateway
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getVpnGateway

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Retrieves the details of a virtual wan vpn gateway.

Uses Azure REST API version 2024-05-01.

Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

Using getVpnGateway

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVpnGateway(args: GetVpnGatewayArgs, opts?: InvokeOptions): Promise<GetVpnGatewayResult>
function getVpnGatewayOutput(args: GetVpnGatewayOutputArgs, opts?: InvokeOptions): Output<GetVpnGatewayResult>
Copy
def get_vpn_gateway(gateway_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetVpnGatewayResult
def get_vpn_gateway_output(gateway_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetVpnGatewayResult]
Copy
func LookupVpnGateway(ctx *Context, args *LookupVpnGatewayArgs, opts ...InvokeOption) (*LookupVpnGatewayResult, error)
func LookupVpnGatewayOutput(ctx *Context, args *LookupVpnGatewayOutputArgs, opts ...InvokeOption) LookupVpnGatewayResultOutput
Copy

> Note: This function is named LookupVpnGateway in the Go SDK.

public static class GetVpnGateway 
{
    public static Task<GetVpnGatewayResult> InvokeAsync(GetVpnGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetVpnGatewayResult> Invoke(GetVpnGatewayInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVpnGatewayResult> getVpnGateway(GetVpnGatewayArgs args, InvokeOptions options)
public static Output<GetVpnGatewayResult> getVpnGateway(GetVpnGatewayArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getVpnGateway
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the VpnGateway.
GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the VpnGateway.
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name of the VpnGateway.
gatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the VpnGateway.
gateway_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the gateway.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name of the VpnGateway.
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name of the VpnGateway.

getVpnGateway Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
IpConfigurations List<Pulumi.AzureNative.Network.Outputs.VpnGatewayIpConfigurationResponse>
List of all IPs configured on the gateway.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
The provisioning state of the VPN gateway resource.
Type string
Resource type.
BgpSettings Pulumi.AzureNative.Network.Outputs.BgpSettingsResponse
Local network gateway's BGP speaker settings.
Connections List<Pulumi.AzureNative.Network.Outputs.VpnConnectionResponse>
List of all vpn connections to the gateway.
EnableBgpRouteTranslationForNat bool
Enable BGP routes translation for NAT on this VpnGateway.
Id string
Resource ID.
IsRoutingPreferenceInternet bool
Enable Routing Preference property for the Public IP Interface of the VpnGateway.
NatRules List<Pulumi.AzureNative.Network.Outputs.VpnGatewayNatRuleResponse>
List of all the nat Rules associated with the gateway.
Tags Dictionary<string, string>
Resource tags.
VirtualHub Pulumi.AzureNative.Network.Outputs.SubResourceResponse
The VirtualHub to which the gateway belongs.
VpnGatewayScaleUnit int
The scale unit for this vpn gateway.
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
IpConfigurations []VpnGatewayIpConfigurationResponse
List of all IPs configured on the gateway.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
The provisioning state of the VPN gateway resource.
Type string
Resource type.
BgpSettings BgpSettingsResponse
Local network gateway's BGP speaker settings.
Connections []VpnConnectionResponse
List of all vpn connections to the gateway.
EnableBgpRouteTranslationForNat bool
Enable BGP routes translation for NAT on this VpnGateway.
Id string
Resource ID.
IsRoutingPreferenceInternet bool
Enable Routing Preference property for the Public IP Interface of the VpnGateway.
NatRules []VpnGatewayNatRuleResponse
List of all the nat Rules associated with the gateway.
Tags map[string]string
Resource tags.
VirtualHub SubResourceResponse
The VirtualHub to which the gateway belongs.
VpnGatewayScaleUnit int
The scale unit for this vpn gateway.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
ipConfigurations List<VpnGatewayIpConfigurationResponse>
List of all IPs configured on the gateway.
location String
Resource location.
name String
Resource name.
provisioningState String
The provisioning state of the VPN gateway resource.
type String
Resource type.
bgpSettings BgpSettingsResponse
Local network gateway's BGP speaker settings.
connections List<VpnConnectionResponse>
List of all vpn connections to the gateway.
enableBgpRouteTranslationForNat Boolean
Enable BGP routes translation for NAT on this VpnGateway.
id String
Resource ID.
isRoutingPreferenceInternet Boolean
Enable Routing Preference property for the Public IP Interface of the VpnGateway.
natRules List<VpnGatewayNatRuleResponse>
List of all the nat Rules associated with the gateway.
tags Map<String,String>
Resource tags.
virtualHub SubResourceResponse
The VirtualHub to which the gateway belongs.
vpnGatewayScaleUnit Integer
The scale unit for this vpn gateway.
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
ipConfigurations VpnGatewayIpConfigurationResponse[]
List of all IPs configured on the gateway.
location string
Resource location.
name string
Resource name.
provisioningState string
The provisioning state of the VPN gateway resource.
type string
Resource type.
bgpSettings BgpSettingsResponse
Local network gateway's BGP speaker settings.
connections VpnConnectionResponse[]
List of all vpn connections to the gateway.
enableBgpRouteTranslationForNat boolean
Enable BGP routes translation for NAT on this VpnGateway.
id string
Resource ID.
isRoutingPreferenceInternet boolean
Enable Routing Preference property for the Public IP Interface of the VpnGateway.
natRules VpnGatewayNatRuleResponse[]
List of all the nat Rules associated with the gateway.
tags {[key: string]: string}
Resource tags.
virtualHub SubResourceResponse
The VirtualHub to which the gateway belongs.
vpnGatewayScaleUnit number
The scale unit for this vpn gateway.
azure_api_version str
The Azure API version of the resource.
etag str
A unique read-only string that changes whenever the resource is updated.
ip_configurations Sequence[VpnGatewayIpConfigurationResponse]
List of all IPs configured on the gateway.
location str
Resource location.
name str
Resource name.
provisioning_state str
The provisioning state of the VPN gateway resource.
type str
Resource type.
bgp_settings BgpSettingsResponse
Local network gateway's BGP speaker settings.
connections Sequence[VpnConnectionResponse]
List of all vpn connections to the gateway.
enable_bgp_route_translation_for_nat bool
Enable BGP routes translation for NAT on this VpnGateway.
id str
Resource ID.
is_routing_preference_internet bool
Enable Routing Preference property for the Public IP Interface of the VpnGateway.
nat_rules Sequence[VpnGatewayNatRuleResponse]
List of all the nat Rules associated with the gateway.
tags Mapping[str, str]
Resource tags.
virtual_hub SubResourceResponse
The VirtualHub to which the gateway belongs.
vpn_gateway_scale_unit int
The scale unit for this vpn gateway.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
ipConfigurations List<Property Map>
List of all IPs configured on the gateway.
location String
Resource location.
name String
Resource name.
provisioningState String
The provisioning state of the VPN gateway resource.
type String
Resource type.
bgpSettings Property Map
Local network gateway's BGP speaker settings.
connections List<Property Map>
List of all vpn connections to the gateway.
enableBgpRouteTranslationForNat Boolean
Enable BGP routes translation for NAT on this VpnGateway.
id String
Resource ID.
isRoutingPreferenceInternet Boolean
Enable Routing Preference property for the Public IP Interface of the VpnGateway.
natRules List<Property Map>
List of all the nat Rules associated with the gateway.
tags Map<String>
Resource tags.
virtualHub Property Map
The VirtualHub to which the gateway belongs.
vpnGatewayScaleUnit Number
The scale unit for this vpn gateway.

Supporting Types

BgpSettingsResponse

Asn double
The BGP speaker's ASN.
BgpPeeringAddress string
The BGP peering address and BGP identifier of this BGP speaker.
BgpPeeringAddresses List<Pulumi.AzureNative.Network.Inputs.IPConfigurationBgpPeeringAddressResponse>
BGP peering address with IP configuration ID for virtual network gateway.
PeerWeight int
The weight added to routes learned from this BGP speaker.
Asn float64
The BGP speaker's ASN.
BgpPeeringAddress string
The BGP peering address and BGP identifier of this BGP speaker.
BgpPeeringAddresses []IPConfigurationBgpPeeringAddressResponse
BGP peering address with IP configuration ID for virtual network gateway.
PeerWeight int
The weight added to routes learned from this BGP speaker.
asn Double
The BGP speaker's ASN.
bgpPeeringAddress String
The BGP peering address and BGP identifier of this BGP speaker.
bgpPeeringAddresses List<IPConfigurationBgpPeeringAddressResponse>
BGP peering address with IP configuration ID for virtual network gateway.
peerWeight Integer
The weight added to routes learned from this BGP speaker.
asn number
The BGP speaker's ASN.
bgpPeeringAddress string
The BGP peering address and BGP identifier of this BGP speaker.
bgpPeeringAddresses IPConfigurationBgpPeeringAddressResponse[]
BGP peering address with IP configuration ID for virtual network gateway.
peerWeight number
The weight added to routes learned from this BGP speaker.
asn float
The BGP speaker's ASN.
bgp_peering_address str
The BGP peering address and BGP identifier of this BGP speaker.
bgp_peering_addresses Sequence[IPConfigurationBgpPeeringAddressResponse]
BGP peering address with IP configuration ID for virtual network gateway.
peer_weight int
The weight added to routes learned from this BGP speaker.
asn Number
The BGP speaker's ASN.
bgpPeeringAddress String
The BGP peering address and BGP identifier of this BGP speaker.
bgpPeeringAddresses List<Property Map>
BGP peering address with IP configuration ID for virtual network gateway.
peerWeight Number
The weight added to routes learned from this BGP speaker.

GatewayCustomBgpIpAddressIpConfigurationResponse

CustomBgpIpAddress This property is required. string
The custom BgpPeeringAddress which belongs to IpconfigurationId.
IpConfigurationId This property is required. string
The IpconfigurationId of ipconfiguration which belongs to gateway.
CustomBgpIpAddress This property is required. string
The custom BgpPeeringAddress which belongs to IpconfigurationId.
IpConfigurationId This property is required. string
The IpconfigurationId of ipconfiguration which belongs to gateway.
customBgpIpAddress This property is required. String
The custom BgpPeeringAddress which belongs to IpconfigurationId.
ipConfigurationId This property is required. String
The IpconfigurationId of ipconfiguration which belongs to gateway.
customBgpIpAddress This property is required. string
The custom BgpPeeringAddress which belongs to IpconfigurationId.
ipConfigurationId This property is required. string
The IpconfigurationId of ipconfiguration which belongs to gateway.
custom_bgp_ip_address This property is required. str
The custom BgpPeeringAddress which belongs to IpconfigurationId.
ip_configuration_id This property is required. str
The IpconfigurationId of ipconfiguration which belongs to gateway.
customBgpIpAddress This property is required. String
The custom BgpPeeringAddress which belongs to IpconfigurationId.
ipConfigurationId This property is required. String
The IpconfigurationId of ipconfiguration which belongs to gateway.

IPConfigurationBgpPeeringAddressResponse

DefaultBgpIpAddresses This property is required. List<string>
The list of default BGP peering addresses which belong to IP configuration.
TunnelIpAddresses This property is required. List<string>
The list of tunnel public IP addresses which belong to IP configuration.
CustomBgpIpAddresses List<string>
The list of custom BGP peering addresses which belong to IP configuration.
IpconfigurationId string
The ID of IP configuration which belongs to gateway.
DefaultBgpIpAddresses This property is required. []string
The list of default BGP peering addresses which belong to IP configuration.
TunnelIpAddresses This property is required. []string
The list of tunnel public IP addresses which belong to IP configuration.
CustomBgpIpAddresses []string
The list of custom BGP peering addresses which belong to IP configuration.
IpconfigurationId string
The ID of IP configuration which belongs to gateway.
defaultBgpIpAddresses This property is required. List<String>
The list of default BGP peering addresses which belong to IP configuration.
tunnelIpAddresses This property is required. List<String>
The list of tunnel public IP addresses which belong to IP configuration.
customBgpIpAddresses List<String>
The list of custom BGP peering addresses which belong to IP configuration.
ipconfigurationId String
The ID of IP configuration which belongs to gateway.
defaultBgpIpAddresses This property is required. string[]
The list of default BGP peering addresses which belong to IP configuration.
tunnelIpAddresses This property is required. string[]
The list of tunnel public IP addresses which belong to IP configuration.
customBgpIpAddresses string[]
The list of custom BGP peering addresses which belong to IP configuration.
ipconfigurationId string
The ID of IP configuration which belongs to gateway.
default_bgp_ip_addresses This property is required. Sequence[str]
The list of default BGP peering addresses which belong to IP configuration.
tunnel_ip_addresses This property is required. Sequence[str]
The list of tunnel public IP addresses which belong to IP configuration.
custom_bgp_ip_addresses Sequence[str]
The list of custom BGP peering addresses which belong to IP configuration.
ipconfiguration_id str
The ID of IP configuration which belongs to gateway.
defaultBgpIpAddresses This property is required. List<String>
The list of default BGP peering addresses which belong to IP configuration.
tunnelIpAddresses This property is required. List<String>
The list of tunnel public IP addresses which belong to IP configuration.
customBgpIpAddresses List<String>
The list of custom BGP peering addresses which belong to IP configuration.
ipconfigurationId String
The ID of IP configuration which belongs to gateway.

IpsecPolicyResponse

DhGroup This property is required. string
The DH Group used in IKE Phase 1 for initial SA.
IkeEncryption This property is required. string
The IKE encryption algorithm (IKE phase 2).
IkeIntegrity This property is required. string
The IKE integrity algorithm (IKE phase 2).
IpsecEncryption This property is required. string
The IPSec encryption algorithm (IKE phase 1).
IpsecIntegrity This property is required. string
The IPSec integrity algorithm (IKE phase 1).
PfsGroup This property is required. string
The Pfs Group used in IKE Phase 2 for new child SA.
SaDataSizeKilobytes This property is required. int
The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
SaLifeTimeSeconds This property is required. int
The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
DhGroup This property is required. string
The DH Group used in IKE Phase 1 for initial SA.
IkeEncryption This property is required. string
The IKE encryption algorithm (IKE phase 2).
IkeIntegrity This property is required. string
The IKE integrity algorithm (IKE phase 2).
IpsecEncryption This property is required. string
The IPSec encryption algorithm (IKE phase 1).
IpsecIntegrity This property is required. string
The IPSec integrity algorithm (IKE phase 1).
PfsGroup This property is required. string
The Pfs Group used in IKE Phase 2 for new child SA.
SaDataSizeKilobytes This property is required. int
The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
SaLifeTimeSeconds This property is required. int
The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
dhGroup This property is required. String
The DH Group used in IKE Phase 1 for initial SA.
ikeEncryption This property is required. String
The IKE encryption algorithm (IKE phase 2).
ikeIntegrity This property is required. String
The IKE integrity algorithm (IKE phase 2).
ipsecEncryption This property is required. String
The IPSec encryption algorithm (IKE phase 1).
ipsecIntegrity This property is required. String
The IPSec integrity algorithm (IKE phase 1).
pfsGroup This property is required. String
The Pfs Group used in IKE Phase 2 for new child SA.
saDataSizeKilobytes This property is required. Integer
The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
saLifeTimeSeconds This property is required. Integer
The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
dhGroup This property is required. string
The DH Group used in IKE Phase 1 for initial SA.
ikeEncryption This property is required. string
The IKE encryption algorithm (IKE phase 2).
ikeIntegrity This property is required. string
The IKE integrity algorithm (IKE phase 2).
ipsecEncryption This property is required. string
The IPSec encryption algorithm (IKE phase 1).
ipsecIntegrity This property is required. string
The IPSec integrity algorithm (IKE phase 1).
pfsGroup This property is required. string
The Pfs Group used in IKE Phase 2 for new child SA.
saDataSizeKilobytes This property is required. number
The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
saLifeTimeSeconds This property is required. number
The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
dh_group This property is required. str
The DH Group used in IKE Phase 1 for initial SA.
ike_encryption This property is required. str
The IKE encryption algorithm (IKE phase 2).
ike_integrity This property is required. str
The IKE integrity algorithm (IKE phase 2).
ipsec_encryption This property is required. str
The IPSec encryption algorithm (IKE phase 1).
ipsec_integrity This property is required. str
The IPSec integrity algorithm (IKE phase 1).
pfs_group This property is required. str
The Pfs Group used in IKE Phase 2 for new child SA.
sa_data_size_kilobytes This property is required. int
The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
sa_life_time_seconds This property is required. int
The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
dhGroup This property is required. String
The DH Group used in IKE Phase 1 for initial SA.
ikeEncryption This property is required. String
The IKE encryption algorithm (IKE phase 2).
ikeIntegrity This property is required. String
The IKE integrity algorithm (IKE phase 2).
ipsecEncryption This property is required. String
The IPSec encryption algorithm (IKE phase 1).
ipsecIntegrity This property is required. String
The IPSec integrity algorithm (IKE phase 1).
pfsGroup This property is required. String
The Pfs Group used in IKE Phase 2 for new child SA.
saDataSizeKilobytes This property is required. Number
The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
saLifeTimeSeconds This property is required. Number
The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.

PropagatedRouteTableResponse

Ids List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
The list of resource ids of all the RouteTables.
Labels List<string>
The list of labels.
Ids []SubResourceResponse
The list of resource ids of all the RouteTables.
Labels []string
The list of labels.
ids List<SubResourceResponse>
The list of resource ids of all the RouteTables.
labels List<String>
The list of labels.
ids SubResourceResponse[]
The list of resource ids of all the RouteTables.
labels string[]
The list of labels.
ids Sequence[SubResourceResponse]
The list of resource ids of all the RouteTables.
labels Sequence[str]
The list of labels.
ids List<Property Map>
The list of resource ids of all the RouteTables.
labels List<String>
The list of labels.

RoutingConfigurationResponse

AssociatedRouteTable Pulumi.AzureNative.Network.Inputs.SubResourceResponse
The resource id RouteTable associated with this RoutingConfiguration.
InboundRouteMap Pulumi.AzureNative.Network.Inputs.SubResourceResponse
The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
OutboundRouteMap Pulumi.AzureNative.Network.Inputs.SubResourceResponse
The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
PropagatedRouteTables Pulumi.AzureNative.Network.Inputs.PropagatedRouteTableResponse
The list of RouteTables to advertise the routes to.
VnetRoutes Pulumi.AzureNative.Network.Inputs.VnetRouteResponse
List of routes that control routing from VirtualHub into a virtual network connection.
AssociatedRouteTable SubResourceResponse
The resource id RouteTable associated with this RoutingConfiguration.
InboundRouteMap SubResourceResponse
The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
OutboundRouteMap SubResourceResponse
The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
PropagatedRouteTables PropagatedRouteTableResponse
The list of RouteTables to advertise the routes to.
VnetRoutes VnetRouteResponse
List of routes that control routing from VirtualHub into a virtual network connection.
associatedRouteTable SubResourceResponse
The resource id RouteTable associated with this RoutingConfiguration.
inboundRouteMap SubResourceResponse
The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
outboundRouteMap SubResourceResponse
The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
propagatedRouteTables PropagatedRouteTableResponse
The list of RouteTables to advertise the routes to.
vnetRoutes VnetRouteResponse
List of routes that control routing from VirtualHub into a virtual network connection.
associatedRouteTable SubResourceResponse
The resource id RouteTable associated with this RoutingConfiguration.
inboundRouteMap SubResourceResponse
The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
outboundRouteMap SubResourceResponse
The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
propagatedRouteTables PropagatedRouteTableResponse
The list of RouteTables to advertise the routes to.
vnetRoutes VnetRouteResponse
List of routes that control routing from VirtualHub into a virtual network connection.
associated_route_table SubResourceResponse
The resource id RouteTable associated with this RoutingConfiguration.
inbound_route_map SubResourceResponse
The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
outbound_route_map SubResourceResponse
The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
propagated_route_tables PropagatedRouteTableResponse
The list of RouteTables to advertise the routes to.
vnet_routes VnetRouteResponse
List of routes that control routing from VirtualHub into a virtual network connection.
associatedRouteTable Property Map
The resource id RouteTable associated with this RoutingConfiguration.
inboundRouteMap Property Map
The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
outboundRouteMap Property Map
The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
propagatedRouteTables Property Map
The list of RouteTables to advertise the routes to.
vnetRoutes Property Map
List of routes that control routing from VirtualHub into a virtual network connection.

StaticRouteResponse

AddressPrefixes List<string>
List of all address prefixes.
Name string
The name of the StaticRoute that is unique within a VnetRoute.
NextHopIpAddress string
The ip address of the next hop.
AddressPrefixes []string
List of all address prefixes.
Name string
The name of the StaticRoute that is unique within a VnetRoute.
NextHopIpAddress string
The ip address of the next hop.
addressPrefixes List<String>
List of all address prefixes.
name String
The name of the StaticRoute that is unique within a VnetRoute.
nextHopIpAddress String
The ip address of the next hop.
addressPrefixes string[]
List of all address prefixes.
name string
The name of the StaticRoute that is unique within a VnetRoute.
nextHopIpAddress string
The ip address of the next hop.
address_prefixes Sequence[str]
List of all address prefixes.
name str
The name of the StaticRoute that is unique within a VnetRoute.
next_hop_ip_address str
The ip address of the next hop.
addressPrefixes List<String>
List of all address prefixes.
name String
The name of the StaticRoute that is unique within a VnetRoute.
nextHopIpAddress String
The ip address of the next hop.

StaticRoutesConfigResponse

PropagateStaticRoutes This property is required. bool
Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
VnetLocalRouteOverrideCriteria string
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
PropagateStaticRoutes This property is required. bool
Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
VnetLocalRouteOverrideCriteria string
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
propagateStaticRoutes This property is required. Boolean
Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
vnetLocalRouteOverrideCriteria String
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
propagateStaticRoutes This property is required. boolean
Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
vnetLocalRouteOverrideCriteria string
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
propagate_static_routes This property is required. bool
Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
vnet_local_route_override_criteria str
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
propagateStaticRoutes This property is required. Boolean
Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
vnetLocalRouteOverrideCriteria String
Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.

SubResourceResponse

Id string
Resource ID.
Id string
Resource ID.
id String
Resource ID.
id string
Resource ID.
id str
Resource ID.
id String
Resource ID.

TrafficSelectorPolicyResponse

LocalAddressRanges This property is required. List<string>
A collection of local address spaces in CIDR format.
RemoteAddressRanges This property is required. List<string>
A collection of remote address spaces in CIDR format.
LocalAddressRanges This property is required. []string
A collection of local address spaces in CIDR format.
RemoteAddressRanges This property is required. []string
A collection of remote address spaces in CIDR format.
localAddressRanges This property is required. List<String>
A collection of local address spaces in CIDR format.
remoteAddressRanges This property is required. List<String>
A collection of remote address spaces in CIDR format.
localAddressRanges This property is required. string[]
A collection of local address spaces in CIDR format.
remoteAddressRanges This property is required. string[]
A collection of remote address spaces in CIDR format.
local_address_ranges This property is required. Sequence[str]
A collection of local address spaces in CIDR format.
remote_address_ranges This property is required. Sequence[str]
A collection of remote address spaces in CIDR format.
localAddressRanges This property is required. List<String>
A collection of local address spaces in CIDR format.
remoteAddressRanges This property is required. List<String>
A collection of remote address spaces in CIDR format.

VnetRouteResponse

BgpConnections This property is required. List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
The list of references to HubBgpConnection objects.
StaticRoutes List<Pulumi.AzureNative.Network.Inputs.StaticRouteResponse>
List of all Static Routes.
StaticRoutesConfig Pulumi.AzureNative.Network.Inputs.StaticRoutesConfigResponse
Configuration for static routes on this HubVnetConnection.
BgpConnections This property is required. []SubResourceResponse
The list of references to HubBgpConnection objects.
StaticRoutes []StaticRouteResponse
List of all Static Routes.
StaticRoutesConfig StaticRoutesConfigResponse
Configuration for static routes on this HubVnetConnection.
bgpConnections This property is required. List<SubResourceResponse>
The list of references to HubBgpConnection objects.
staticRoutes List<StaticRouteResponse>
List of all Static Routes.
staticRoutesConfig StaticRoutesConfigResponse
Configuration for static routes on this HubVnetConnection.
bgpConnections This property is required. SubResourceResponse[]
The list of references to HubBgpConnection objects.
staticRoutes StaticRouteResponse[]
List of all Static Routes.
staticRoutesConfig StaticRoutesConfigResponse
Configuration for static routes on this HubVnetConnection.
bgp_connections This property is required. Sequence[SubResourceResponse]
The list of references to HubBgpConnection objects.
static_routes Sequence[StaticRouteResponse]
List of all Static Routes.
static_routes_config StaticRoutesConfigResponse
Configuration for static routes on this HubVnetConnection.
bgpConnections This property is required. List<Property Map>
The list of references to HubBgpConnection objects.
staticRoutes List<Property Map>
List of all Static Routes.
staticRoutesConfig Property Map
Configuration for static routes on this HubVnetConnection.

VpnConnectionResponse

ConnectionStatus This property is required. string
The connection status.
EgressBytesTransferred This property is required. double
Egress bytes transferred.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
IngressBytesTransferred This property is required. double
Ingress bytes transferred.
ProvisioningState This property is required. string
The provisioning state of the VPN connection resource.
ConnectionBandwidth int
Expected bandwidth in MBPS.
DpdTimeoutSeconds int
DPD timeout in seconds for vpn connection.
EnableBgp bool
EnableBgp flag.
EnableInternetSecurity bool
Enable internet security.
EnableRateLimiting bool
EnableBgp flag.
Id string
Resource ID.
IpsecPolicies List<Pulumi.AzureNative.Network.Inputs.IpsecPolicyResponse>
The IPSec Policies to be considered by this connection.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
RemoteVpnSite Pulumi.AzureNative.Network.Inputs.SubResourceResponse
Id of the connected vpn site.
RoutingConfiguration Pulumi.AzureNative.Network.Inputs.RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
RoutingWeight int
Routing weight for vpn connection.
SharedKey string
SharedKey for the vpn connection.
TrafficSelectorPolicies List<Pulumi.AzureNative.Network.Inputs.TrafficSelectorPolicyResponse>
The Traffic Selector Policies to be considered by this connection.
UseLocalAzureIpAddress bool
Use local azure ip to initiate connection.
UsePolicyBasedTrafficSelectors bool
Enable policy-based traffic selectors.
VpnConnectionProtocolType string
Connection protocol used for this connection.
VpnLinkConnections List<Pulumi.AzureNative.Network.Inputs.VpnSiteLinkConnectionResponse>
List of all vpn site link connections to the gateway.
ConnectionStatus This property is required. string
The connection status.
EgressBytesTransferred This property is required. float64
Egress bytes transferred.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
IngressBytesTransferred This property is required. float64
Ingress bytes transferred.
ProvisioningState This property is required. string
The provisioning state of the VPN connection resource.
ConnectionBandwidth int
Expected bandwidth in MBPS.
DpdTimeoutSeconds int
DPD timeout in seconds for vpn connection.
EnableBgp bool
EnableBgp flag.
EnableInternetSecurity bool
Enable internet security.
EnableRateLimiting bool
EnableBgp flag.
Id string
Resource ID.
IpsecPolicies []IpsecPolicyResponse
The IPSec Policies to be considered by this connection.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
RemoteVpnSite SubResourceResponse
Id of the connected vpn site.
RoutingConfiguration RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
RoutingWeight int
Routing weight for vpn connection.
SharedKey string
SharedKey for the vpn connection.
TrafficSelectorPolicies []TrafficSelectorPolicyResponse
The Traffic Selector Policies to be considered by this connection.
UseLocalAzureIpAddress bool
Use local azure ip to initiate connection.
UsePolicyBasedTrafficSelectors bool
Enable policy-based traffic selectors.
VpnConnectionProtocolType string
Connection protocol used for this connection.
VpnLinkConnections []VpnSiteLinkConnectionResponse
List of all vpn site link connections to the gateway.
connectionStatus This property is required. String
The connection status.
egressBytesTransferred This property is required. Double
Egress bytes transferred.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
ingressBytesTransferred This property is required. Double
Ingress bytes transferred.
provisioningState This property is required. String
The provisioning state of the VPN connection resource.
connectionBandwidth Integer
Expected bandwidth in MBPS.
dpdTimeoutSeconds Integer
DPD timeout in seconds for vpn connection.
enableBgp Boolean
EnableBgp flag.
enableInternetSecurity Boolean
Enable internet security.
enableRateLimiting Boolean
EnableBgp flag.
id String
Resource ID.
ipsecPolicies List<IpsecPolicyResponse>
The IPSec Policies to be considered by this connection.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
remoteVpnSite SubResourceResponse
Id of the connected vpn site.
routingConfiguration RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
routingWeight Integer
Routing weight for vpn connection.
sharedKey String
SharedKey for the vpn connection.
trafficSelectorPolicies List<TrafficSelectorPolicyResponse>
The Traffic Selector Policies to be considered by this connection.
useLocalAzureIpAddress Boolean
Use local azure ip to initiate connection.
usePolicyBasedTrafficSelectors Boolean
Enable policy-based traffic selectors.
vpnConnectionProtocolType String
Connection protocol used for this connection.
vpnLinkConnections List<VpnSiteLinkConnectionResponse>
List of all vpn site link connections to the gateway.
connectionStatus This property is required. string
The connection status.
egressBytesTransferred This property is required. number
Egress bytes transferred.
etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
ingressBytesTransferred This property is required. number
Ingress bytes transferred.
provisioningState This property is required. string
The provisioning state of the VPN connection resource.
connectionBandwidth number
Expected bandwidth in MBPS.
dpdTimeoutSeconds number
DPD timeout in seconds for vpn connection.
enableBgp boolean
EnableBgp flag.
enableInternetSecurity boolean
Enable internet security.
enableRateLimiting boolean
EnableBgp flag.
id string
Resource ID.
ipsecPolicies IpsecPolicyResponse[]
The IPSec Policies to be considered by this connection.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
remoteVpnSite SubResourceResponse
Id of the connected vpn site.
routingConfiguration RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
routingWeight number
Routing weight for vpn connection.
sharedKey string
SharedKey for the vpn connection.
trafficSelectorPolicies TrafficSelectorPolicyResponse[]
The Traffic Selector Policies to be considered by this connection.
useLocalAzureIpAddress boolean
Use local azure ip to initiate connection.
usePolicyBasedTrafficSelectors boolean
Enable policy-based traffic selectors.
vpnConnectionProtocolType string
Connection protocol used for this connection.
vpnLinkConnections VpnSiteLinkConnectionResponse[]
List of all vpn site link connections to the gateway.
connection_status This property is required. str
The connection status.
egress_bytes_transferred This property is required. float
Egress bytes transferred.
etag This property is required. str
A unique read-only string that changes whenever the resource is updated.
ingress_bytes_transferred This property is required. float
Ingress bytes transferred.
provisioning_state This property is required. str
The provisioning state of the VPN connection resource.
connection_bandwidth int
Expected bandwidth in MBPS.
dpd_timeout_seconds int
DPD timeout in seconds for vpn connection.
enable_bgp bool
EnableBgp flag.
enable_internet_security bool
Enable internet security.
enable_rate_limiting bool
EnableBgp flag.
id str
Resource ID.
ipsec_policies Sequence[IpsecPolicyResponse]
The IPSec Policies to be considered by this connection.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
remote_vpn_site SubResourceResponse
Id of the connected vpn site.
routing_configuration RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
routing_weight int
Routing weight for vpn connection.
shared_key str
SharedKey for the vpn connection.
traffic_selector_policies Sequence[TrafficSelectorPolicyResponse]
The Traffic Selector Policies to be considered by this connection.
use_local_azure_ip_address bool
Use local azure ip to initiate connection.
use_policy_based_traffic_selectors bool
Enable policy-based traffic selectors.
vpn_connection_protocol_type str
Connection protocol used for this connection.
vpn_link_connections Sequence[VpnSiteLinkConnectionResponse]
List of all vpn site link connections to the gateway.
connectionStatus This property is required. String
The connection status.
egressBytesTransferred This property is required. Number
Egress bytes transferred.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
ingressBytesTransferred This property is required. Number
Ingress bytes transferred.
provisioningState This property is required. String
The provisioning state of the VPN connection resource.
connectionBandwidth Number
Expected bandwidth in MBPS.
dpdTimeoutSeconds Number
DPD timeout in seconds for vpn connection.
enableBgp Boolean
EnableBgp flag.
enableInternetSecurity Boolean
Enable internet security.
enableRateLimiting Boolean
EnableBgp flag.
id String
Resource ID.
ipsecPolicies List<Property Map>
The IPSec Policies to be considered by this connection.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
remoteVpnSite Property Map
Id of the connected vpn site.
routingConfiguration Property Map
The Routing Configuration indicating the associated and propagated route tables on this connection.
routingWeight Number
Routing weight for vpn connection.
sharedKey String
SharedKey for the vpn connection.
trafficSelectorPolicies List<Property Map>
The Traffic Selector Policies to be considered by this connection.
useLocalAzureIpAddress Boolean
Use local azure ip to initiate connection.
usePolicyBasedTrafficSelectors Boolean
Enable policy-based traffic selectors.
vpnConnectionProtocolType String
Connection protocol used for this connection.
vpnLinkConnections List<Property Map>
List of all vpn site link connections to the gateway.

VpnGatewayIpConfigurationResponse

Id string
The identifier of the IP configuration for a VPN Gateway.
PrivateIpAddress string
The private IP address of this IP configuration.
PublicIpAddress string
The public IP address of this IP configuration.
Id string
The identifier of the IP configuration for a VPN Gateway.
PrivateIpAddress string
The private IP address of this IP configuration.
PublicIpAddress string
The public IP address of this IP configuration.
id String
The identifier of the IP configuration for a VPN Gateway.
privateIpAddress String
The private IP address of this IP configuration.
publicIpAddress String
The public IP address of this IP configuration.
id string
The identifier of the IP configuration for a VPN Gateway.
privateIpAddress string
The private IP address of this IP configuration.
publicIpAddress string
The public IP address of this IP configuration.
id str
The identifier of the IP configuration for a VPN Gateway.
private_ip_address str
The private IP address of this IP configuration.
public_ip_address str
The public IP address of this IP configuration.
id String
The identifier of the IP configuration for a VPN Gateway.
privateIpAddress String
The private IP address of this IP configuration.
publicIpAddress String
The public IP address of this IP configuration.

VpnGatewayNatRuleResponse

EgressVpnSiteLinkConnections This property is required. List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
List of egress VpnSiteLinkConnections.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
IngressVpnSiteLinkConnections This property is required. List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
List of ingress VpnSiteLinkConnections.
ProvisioningState This property is required. string
The provisioning state of the NAT Rule resource.
Type This property is required. string
Resource type.
ExternalMappings List<Pulumi.AzureNative.Network.Inputs.VpnNatRuleMappingResponse>
The private IP address external mapping for NAT.
Id string
Resource ID.
InternalMappings List<Pulumi.AzureNative.Network.Inputs.VpnNatRuleMappingResponse>
The private IP address internal mapping for NAT.
IpConfigurationId string
The IP Configuration ID this NAT rule applies to.
Mode string
The Source NAT direction of a VPN NAT.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
EgressVpnSiteLinkConnections This property is required. []SubResourceResponse
List of egress VpnSiteLinkConnections.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
IngressVpnSiteLinkConnections This property is required. []SubResourceResponse
List of ingress VpnSiteLinkConnections.
ProvisioningState This property is required. string
The provisioning state of the NAT Rule resource.
Type This property is required. string
Resource type.
ExternalMappings []VpnNatRuleMappingResponse
The private IP address external mapping for NAT.
Id string
Resource ID.
InternalMappings []VpnNatRuleMappingResponse
The private IP address internal mapping for NAT.
IpConfigurationId string
The IP Configuration ID this NAT rule applies to.
Mode string
The Source NAT direction of a VPN NAT.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
egressVpnSiteLinkConnections This property is required. List<SubResourceResponse>
List of egress VpnSiteLinkConnections.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
ingressVpnSiteLinkConnections This property is required. List<SubResourceResponse>
List of ingress VpnSiteLinkConnections.
provisioningState This property is required. String
The provisioning state of the NAT Rule resource.
type This property is required. String
Resource type.
externalMappings List<VpnNatRuleMappingResponse>
The private IP address external mapping for NAT.
id String
Resource ID.
internalMappings List<VpnNatRuleMappingResponse>
The private IP address internal mapping for NAT.
ipConfigurationId String
The IP Configuration ID this NAT rule applies to.
mode String
The Source NAT direction of a VPN NAT.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
egressVpnSiteLinkConnections This property is required. SubResourceResponse[]
List of egress VpnSiteLinkConnections.
etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
ingressVpnSiteLinkConnections This property is required. SubResourceResponse[]
List of ingress VpnSiteLinkConnections.
provisioningState This property is required. string
The provisioning state of the NAT Rule resource.
type This property is required. string
Resource type.
externalMappings VpnNatRuleMappingResponse[]
The private IP address external mapping for NAT.
id string
Resource ID.
internalMappings VpnNatRuleMappingResponse[]
The private IP address internal mapping for NAT.
ipConfigurationId string
The IP Configuration ID this NAT rule applies to.
mode string
The Source NAT direction of a VPN NAT.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
egress_vpn_site_link_connections This property is required. Sequence[SubResourceResponse]
List of egress VpnSiteLinkConnections.
etag This property is required. str
A unique read-only string that changes whenever the resource is updated.
ingress_vpn_site_link_connections This property is required. Sequence[SubResourceResponse]
List of ingress VpnSiteLinkConnections.
provisioning_state This property is required. str
The provisioning state of the NAT Rule resource.
type This property is required. str
Resource type.
external_mappings Sequence[VpnNatRuleMappingResponse]
The private IP address external mapping for NAT.
id str
Resource ID.
internal_mappings Sequence[VpnNatRuleMappingResponse]
The private IP address internal mapping for NAT.
ip_configuration_id str
The IP Configuration ID this NAT rule applies to.
mode str
The Source NAT direction of a VPN NAT.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
egressVpnSiteLinkConnections This property is required. List<Property Map>
List of egress VpnSiteLinkConnections.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
ingressVpnSiteLinkConnections This property is required. List<Property Map>
List of ingress VpnSiteLinkConnections.
provisioningState This property is required. String
The provisioning state of the NAT Rule resource.
type This property is required. String
Resource type.
externalMappings List<Property Map>
The private IP address external mapping for NAT.
id String
Resource ID.
internalMappings List<Property Map>
The private IP address internal mapping for NAT.
ipConfigurationId String
The IP Configuration ID this NAT rule applies to.
mode String
The Source NAT direction of a VPN NAT.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.

VpnNatRuleMappingResponse

AddressSpace string
Address space for Vpn NatRule mapping.
PortRange string
Port range for Vpn NatRule mapping.
AddressSpace string
Address space for Vpn NatRule mapping.
PortRange string
Port range for Vpn NatRule mapping.
addressSpace String
Address space for Vpn NatRule mapping.
portRange String
Port range for Vpn NatRule mapping.
addressSpace string
Address space for Vpn NatRule mapping.
portRange string
Port range for Vpn NatRule mapping.
address_space str
Address space for Vpn NatRule mapping.
port_range str
Port range for Vpn NatRule mapping.
addressSpace String
Address space for Vpn NatRule mapping.
portRange String
Port range for Vpn NatRule mapping.

VpnSiteLinkConnectionResponse

ConnectionStatus This property is required. string
The connection status.
EgressBytesTransferred This property is required. double
Egress bytes transferred.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
IngressBytesTransferred This property is required. double
Ingress bytes transferred.
ProvisioningState This property is required. string
The provisioning state of the VPN site link connection resource.
Type This property is required. string
Resource type.
ConnectionBandwidth int
Expected bandwidth in MBPS.
DpdTimeoutSeconds int
Dead Peer Detection timeout in seconds for VpnLink connection.
EgressNatRules List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
List of egress NatRules.
EnableBgp bool
EnableBgp flag.
EnableRateLimiting bool
EnableBgp flag.
Id string
Resource ID.
IngressNatRules List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
List of ingress NatRules.
IpsecPolicies List<Pulumi.AzureNative.Network.Inputs.IpsecPolicyResponse>
The IPSec Policies to be considered by this connection.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
RoutingWeight int
Routing weight for vpn connection.
SharedKey string
SharedKey for the vpn connection.
UseLocalAzureIpAddress bool
Use local azure ip to initiate connection.
UsePolicyBasedTrafficSelectors bool
Enable policy-based traffic selectors.
VpnConnectionProtocolType string
Connection protocol used for this connection.
VpnGatewayCustomBgpAddresses List<Pulumi.AzureNative.Network.Inputs.GatewayCustomBgpIpAddressIpConfigurationResponse>
vpnGatewayCustomBgpAddresses used by this connection.
VpnLinkConnectionMode string
Vpn link connection mode.
VpnSiteLink Pulumi.AzureNative.Network.Inputs.SubResourceResponse
Id of the connected vpn site link.
ConnectionStatus This property is required. string
The connection status.
EgressBytesTransferred This property is required. float64
Egress bytes transferred.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
IngressBytesTransferred This property is required. float64
Ingress bytes transferred.
ProvisioningState This property is required. string
The provisioning state of the VPN site link connection resource.
Type This property is required. string
Resource type.
ConnectionBandwidth int
Expected bandwidth in MBPS.
DpdTimeoutSeconds int
Dead Peer Detection timeout in seconds for VpnLink connection.
EgressNatRules []SubResourceResponse
List of egress NatRules.
EnableBgp bool
EnableBgp flag.
EnableRateLimiting bool
EnableBgp flag.
Id string
Resource ID.
IngressNatRules []SubResourceResponse
List of ingress NatRules.
IpsecPolicies []IpsecPolicyResponse
The IPSec Policies to be considered by this connection.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
RoutingWeight int
Routing weight for vpn connection.
SharedKey string
SharedKey for the vpn connection.
UseLocalAzureIpAddress bool
Use local azure ip to initiate connection.
UsePolicyBasedTrafficSelectors bool
Enable policy-based traffic selectors.
VpnConnectionProtocolType string
Connection protocol used for this connection.
VpnGatewayCustomBgpAddresses []GatewayCustomBgpIpAddressIpConfigurationResponse
vpnGatewayCustomBgpAddresses used by this connection.
VpnLinkConnectionMode string
Vpn link connection mode.
VpnSiteLink SubResourceResponse
Id of the connected vpn site link.
connectionStatus This property is required. String
The connection status.
egressBytesTransferred This property is required. Double
Egress bytes transferred.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
ingressBytesTransferred This property is required. Double
Ingress bytes transferred.
provisioningState This property is required. String
The provisioning state of the VPN site link connection resource.
type This property is required. String
Resource type.
connectionBandwidth Integer
Expected bandwidth in MBPS.
dpdTimeoutSeconds Integer
Dead Peer Detection timeout in seconds for VpnLink connection.
egressNatRules List<SubResourceResponse>
List of egress NatRules.
enableBgp Boolean
EnableBgp flag.
enableRateLimiting Boolean
EnableBgp flag.
id String
Resource ID.
ingressNatRules List<SubResourceResponse>
List of ingress NatRules.
ipsecPolicies List<IpsecPolicyResponse>
The IPSec Policies to be considered by this connection.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
routingWeight Integer
Routing weight for vpn connection.
sharedKey String
SharedKey for the vpn connection.
useLocalAzureIpAddress Boolean
Use local azure ip to initiate connection.
usePolicyBasedTrafficSelectors Boolean
Enable policy-based traffic selectors.
vpnConnectionProtocolType String
Connection protocol used for this connection.
vpnGatewayCustomBgpAddresses List<GatewayCustomBgpIpAddressIpConfigurationResponse>
vpnGatewayCustomBgpAddresses used by this connection.
vpnLinkConnectionMode String
Vpn link connection mode.
vpnSiteLink SubResourceResponse
Id of the connected vpn site link.
connectionStatus This property is required. string
The connection status.
egressBytesTransferred This property is required. number
Egress bytes transferred.
etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
ingressBytesTransferred This property is required. number
Ingress bytes transferred.
provisioningState This property is required. string
The provisioning state of the VPN site link connection resource.
type This property is required. string
Resource type.
connectionBandwidth number
Expected bandwidth in MBPS.
dpdTimeoutSeconds number
Dead Peer Detection timeout in seconds for VpnLink connection.
egressNatRules SubResourceResponse[]
List of egress NatRules.
enableBgp boolean
EnableBgp flag.
enableRateLimiting boolean
EnableBgp flag.
id string
Resource ID.
ingressNatRules SubResourceResponse[]
List of ingress NatRules.
ipsecPolicies IpsecPolicyResponse[]
The IPSec Policies to be considered by this connection.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
routingWeight number
Routing weight for vpn connection.
sharedKey string
SharedKey for the vpn connection.
useLocalAzureIpAddress boolean
Use local azure ip to initiate connection.
usePolicyBasedTrafficSelectors boolean
Enable policy-based traffic selectors.
vpnConnectionProtocolType string
Connection protocol used for this connection.
vpnGatewayCustomBgpAddresses GatewayCustomBgpIpAddressIpConfigurationResponse[]
vpnGatewayCustomBgpAddresses used by this connection.
vpnLinkConnectionMode string
Vpn link connection mode.
vpnSiteLink SubResourceResponse
Id of the connected vpn site link.
connection_status This property is required. str
The connection status.
egress_bytes_transferred This property is required. float
Egress bytes transferred.
etag This property is required. str
A unique read-only string that changes whenever the resource is updated.
ingress_bytes_transferred This property is required. float
Ingress bytes transferred.
provisioning_state This property is required. str
The provisioning state of the VPN site link connection resource.
type This property is required. str
Resource type.
connection_bandwidth int
Expected bandwidth in MBPS.
dpd_timeout_seconds int
Dead Peer Detection timeout in seconds for VpnLink connection.
egress_nat_rules Sequence[SubResourceResponse]
List of egress NatRules.
enable_bgp bool
EnableBgp flag.
enable_rate_limiting bool
EnableBgp flag.
id str
Resource ID.
ingress_nat_rules Sequence[SubResourceResponse]
List of ingress NatRules.
ipsec_policies Sequence[IpsecPolicyResponse]
The IPSec Policies to be considered by this connection.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
routing_weight int
Routing weight for vpn connection.
shared_key str
SharedKey for the vpn connection.
use_local_azure_ip_address bool
Use local azure ip to initiate connection.
use_policy_based_traffic_selectors bool
Enable policy-based traffic selectors.
vpn_connection_protocol_type str
Connection protocol used for this connection.
vpn_gateway_custom_bgp_addresses Sequence[GatewayCustomBgpIpAddressIpConfigurationResponse]
vpnGatewayCustomBgpAddresses used by this connection.
vpn_link_connection_mode str
Vpn link connection mode.
vpn_site_link SubResourceResponse
Id of the connected vpn site link.
connectionStatus This property is required. String
The connection status.
egressBytesTransferred This property is required. Number
Egress bytes transferred.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
ingressBytesTransferred This property is required. Number
Ingress bytes transferred.
provisioningState This property is required. String
The provisioning state of the VPN site link connection resource.
type This property is required. String
Resource type.
connectionBandwidth Number
Expected bandwidth in MBPS.
dpdTimeoutSeconds Number
Dead Peer Detection timeout in seconds for VpnLink connection.
egressNatRules List<Property Map>
List of egress NatRules.
enableBgp Boolean
EnableBgp flag.
enableRateLimiting Boolean
EnableBgp flag.
id String
Resource ID.
ingressNatRules List<Property Map>
List of ingress NatRules.
ipsecPolicies List<Property Map>
The IPSec Policies to be considered by this connection.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
routingWeight Number
Routing weight for vpn connection.
sharedKey String
SharedKey for the vpn connection.
useLocalAzureIpAddress Boolean
Use local azure ip to initiate connection.
usePolicyBasedTrafficSelectors Boolean
Enable policy-based traffic selectors.
vpnConnectionProtocolType String
Connection protocol used for this connection.
vpnGatewayCustomBgpAddresses List<Property Map>
vpnGatewayCustomBgpAddresses used by this connection.
vpnLinkConnectionMode String
Vpn link connection mode.
vpnSiteLink Property Map
Id of the connected vpn site link.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native