Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getVpnSite
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getVpnSite

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

Retrieves the details of a VPN site. Azure REST API version: 2023-02-01.

Other available API versions: 2018-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Using getVpnSite

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 getVpnSite(args: GetVpnSiteArgs, opts?: InvokeOptions): Promise<GetVpnSiteResult>
function getVpnSiteOutput(args: GetVpnSiteOutputArgs, opts?: InvokeOptions): Output<GetVpnSiteResult>
Copy
def get_vpn_site(resource_group_name: Optional[str] = None,
                 vpn_site_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetVpnSiteResult
def get_vpn_site_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                 vpn_site_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetVpnSiteResult]
Copy
func LookupVpnSite(ctx *Context, args *LookupVpnSiteArgs, opts ...InvokeOption) (*LookupVpnSiteResult, error)
func LookupVpnSiteOutput(ctx *Context, args *LookupVpnSiteOutputArgs, opts ...InvokeOption) LookupVpnSiteResultOutput
Copy

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

public static class GetVpnSite 
{
    public static Task<GetVpnSiteResult> InvokeAsync(GetVpnSiteArgs args, InvokeOptions? opts = null)
    public static Output<GetVpnSiteResult> Invoke(GetVpnSiteInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVpnSiteResult> getVpnSite(GetVpnSiteArgs args, InvokeOptions options)
public static Output<GetVpnSiteResult> getVpnSite(GetVpnSiteArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getVpnSite
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the VpnSite.
VpnSiteName
This property is required.
Changes to this property will trigger replacement.
string
The name of the VpnSite being retrieved.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the VpnSite.
VpnSiteName
This property is required.
Changes to this property will trigger replacement.
string
The name of the VpnSite being retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name of the VpnSite.
vpnSiteName
This property is required.
Changes to this property will trigger replacement.
String
The name of the VpnSite being retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the VpnSite.
vpnSiteName
This property is required.
Changes to this property will trigger replacement.
string
The name of the VpnSite being retrieved.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name of the VpnSite.
vpn_site_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the VpnSite being retrieved.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name of the VpnSite.
vpnSiteName
This property is required.
Changes to this property will trigger replacement.
String
The name of the VpnSite being retrieved.

getVpnSite Result

The following output properties are available:

Etag string
A unique read-only string that changes whenever the resource is updated.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
The provisioning state of the VPN site resource.
Type string
Resource type.
AddressSpace Pulumi.AzureNative.Network.Outputs.AddressSpaceResponse
The AddressSpace that contains an array of IP address ranges.
BgpProperties Pulumi.AzureNative.Network.Outputs.BgpSettingsResponse
The set of bgp properties.
DeviceProperties Pulumi.AzureNative.Network.Outputs.DevicePropertiesResponse
The device properties.
Id string
Resource ID.
IpAddress string
The ip-address for the vpn-site.
IsSecuritySite bool
IsSecuritySite flag.
O365Policy Pulumi.AzureNative.Network.Outputs.O365PolicyPropertiesResponse
Office365 Policy.
SiteKey string
The key for vpn-site that can be used for connections.
Tags Dictionary<string, string>
Resource tags.
VirtualWan Pulumi.AzureNative.Network.Outputs.SubResourceResponse
The VirtualWAN to which the vpnSite belongs.
VpnSiteLinks List<Pulumi.AzureNative.Network.Outputs.VpnSiteLinkResponse>
List of all vpn site links.
Etag string
A unique read-only string that changes whenever the resource is updated.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
The provisioning state of the VPN site resource.
Type string
Resource type.
AddressSpace AddressSpaceResponse
The AddressSpace that contains an array of IP address ranges.
BgpProperties BgpSettingsResponse
The set of bgp properties.
DeviceProperties DevicePropertiesResponse
The device properties.
Id string
Resource ID.
IpAddress string
The ip-address for the vpn-site.
IsSecuritySite bool
IsSecuritySite flag.
O365Policy O365PolicyPropertiesResponse
Office365 Policy.
SiteKey string
The key for vpn-site that can be used for connections.
Tags map[string]string
Resource tags.
VirtualWan SubResourceResponse
The VirtualWAN to which the vpnSite belongs.
VpnSiteLinks []VpnSiteLinkResponse
List of all vpn site links.
etag String
A unique read-only string that changes whenever the resource is updated.
location String
Resource location.
name String
Resource name.
provisioningState String
The provisioning state of the VPN site resource.
type String
Resource type.
addressSpace AddressSpaceResponse
The AddressSpace that contains an array of IP address ranges.
bgpProperties BgpSettingsResponse
The set of bgp properties.
deviceProperties DevicePropertiesResponse
The device properties.
id String
Resource ID.
ipAddress String
The ip-address for the vpn-site.
isSecuritySite Boolean
IsSecuritySite flag.
o365Policy O365PolicyPropertiesResponse
Office365 Policy.
siteKey String
The key for vpn-site that can be used for connections.
tags Map<String,String>
Resource tags.
virtualWan SubResourceResponse
The VirtualWAN to which the vpnSite belongs.
vpnSiteLinks List<VpnSiteLinkResponse>
List of all vpn site links.
etag string
A unique read-only string that changes whenever the resource is updated.
location string
Resource location.
name string
Resource name.
provisioningState string
The provisioning state of the VPN site resource.
type string
Resource type.
addressSpace AddressSpaceResponse
The AddressSpace that contains an array of IP address ranges.
bgpProperties BgpSettingsResponse
The set of bgp properties.
deviceProperties DevicePropertiesResponse
The device properties.
id string
Resource ID.
ipAddress string
The ip-address for the vpn-site.
isSecuritySite boolean
IsSecuritySite flag.
o365Policy O365PolicyPropertiesResponse
Office365 Policy.
siteKey string
The key for vpn-site that can be used for connections.
tags {[key: string]: string}
Resource tags.
virtualWan SubResourceResponse
The VirtualWAN to which the vpnSite belongs.
vpnSiteLinks VpnSiteLinkResponse[]
List of all vpn site links.
etag str
A unique read-only string that changes whenever the resource is updated.
location str
Resource location.
name str
Resource name.
provisioning_state str
The provisioning state of the VPN site resource.
type str
Resource type.
address_space AddressSpaceResponse
The AddressSpace that contains an array of IP address ranges.
bgp_properties BgpSettingsResponse
The set of bgp properties.
device_properties DevicePropertiesResponse
The device properties.
id str
Resource ID.
ip_address str
The ip-address for the vpn-site.
is_security_site bool
IsSecuritySite flag.
o365_policy O365PolicyPropertiesResponse
Office365 Policy.
site_key str
The key for vpn-site that can be used for connections.
tags Mapping[str, str]
Resource tags.
virtual_wan SubResourceResponse
The VirtualWAN to which the vpnSite belongs.
vpn_site_links Sequence[VpnSiteLinkResponse]
List of all vpn site links.
etag String
A unique read-only string that changes whenever the resource is updated.
location String
Resource location.
name String
Resource name.
provisioningState String
The provisioning state of the VPN site resource.
type String
Resource type.
addressSpace Property Map
The AddressSpace that contains an array of IP address ranges.
bgpProperties Property Map
The set of bgp properties.
deviceProperties Property Map
The device properties.
id String
Resource ID.
ipAddress String
The ip-address for the vpn-site.
isSecuritySite Boolean
IsSecuritySite flag.
o365Policy Property Map
Office365 Policy.
siteKey String
The key for vpn-site that can be used for connections.
tags Map<String>
Resource tags.
virtualWan Property Map
The VirtualWAN to which the vpnSite belongs.
vpnSiteLinks List<Property Map>
List of all vpn site links.

Supporting Types

AddressSpaceResponse

AddressPrefixes List<string>
A list of address blocks reserved for this virtual network in CIDR notation.
AddressPrefixes []string
A list of address blocks reserved for this virtual network in CIDR notation.
addressPrefixes List<String>
A list of address blocks reserved for this virtual network in CIDR notation.
addressPrefixes string[]
A list of address blocks reserved for this virtual network in CIDR notation.
address_prefixes Sequence[str]
A list of address blocks reserved for this virtual network in CIDR notation.
addressPrefixes List<String>
A list of address blocks reserved for this virtual network in CIDR notation.

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.

DevicePropertiesResponse

DeviceModel string
Model of the device.
DeviceVendor string
Name of the device Vendor.
LinkSpeedInMbps int
Link speed.
DeviceModel string
Model of the device.
DeviceVendor string
Name of the device Vendor.
LinkSpeedInMbps int
Link speed.
deviceModel String
Model of the device.
deviceVendor String
Name of the device Vendor.
linkSpeedInMbps Integer
Link speed.
deviceModel string
Model of the device.
deviceVendor string
Name of the device Vendor.
linkSpeedInMbps number
Link speed.
device_model str
Model of the device.
device_vendor str
Name of the device Vendor.
link_speed_in_mbps int
Link speed.
deviceModel String
Model of the device.
deviceVendor String
Name of the device Vendor.
linkSpeedInMbps Number
Link speed.

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.

O365BreakOutCategoryPoliciesResponse

Allow bool
Flag to control allow category.
Default bool
Flag to control default category.
Optimize bool
Flag to control optimize category.
Allow bool
Flag to control allow category.
Default bool
Flag to control default category.
Optimize bool
Flag to control optimize category.
allow Boolean
Flag to control allow category.
default_ Boolean
Flag to control default category.
optimize Boolean
Flag to control optimize category.
allow boolean
Flag to control allow category.
default boolean
Flag to control default category.
optimize boolean
Flag to control optimize category.
allow bool
Flag to control allow category.
default bool
Flag to control default category.
optimize bool
Flag to control optimize category.
allow Boolean
Flag to control allow category.
default Boolean
Flag to control default category.
optimize Boolean
Flag to control optimize category.

O365PolicyPropertiesResponse

breakOutCategories Property Map
Office365 breakout categories.

SubResourceResponse

Id This property is required. string
Resource ID.
Id This property is required. string
Resource ID.
id This property is required. String
Resource ID.
id This property is required. string
Resource ID.
id This property is required. str
Resource ID.
id This property is required. String
Resource ID.

VpnLinkBgpSettingsResponse

Asn double
The BGP speaker's ASN.
BgpPeeringAddress string
The BGP peering address and BGP identifier of this BGP speaker.
Asn float64
The BGP speaker's ASN.
BgpPeeringAddress string
The BGP peering address and BGP identifier of this BGP speaker.
asn Double
The BGP speaker's ASN.
bgpPeeringAddress String
The BGP peering address and BGP identifier of this BGP speaker.
asn number
The BGP speaker's ASN.
bgpPeeringAddress string
The BGP peering address and BGP identifier of 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.
asn Number
The BGP speaker's ASN.
bgpPeeringAddress String
The BGP peering address and BGP identifier of this BGP speaker.

VpnLinkProviderPropertiesResponse

LinkProviderName string
Name of the link provider.
LinkSpeedInMbps int
Link speed.
LinkProviderName string
Name of the link provider.
LinkSpeedInMbps int
Link speed.
linkProviderName String
Name of the link provider.
linkSpeedInMbps Integer
Link speed.
linkProviderName string
Name of the link provider.
linkSpeedInMbps number
Link speed.
link_provider_name str
Name of the link provider.
link_speed_in_mbps int
Link speed.
linkProviderName String
Name of the link provider.
linkSpeedInMbps Number
Link speed.

VpnSiteLinkResponse

Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState This property is required. string
The provisioning state of the VPN site link resource.
Type This property is required. string
Resource type.
BgpProperties Pulumi.AzureNative.Network.Inputs.VpnLinkBgpSettingsResponse
The set of bgp properties.
Fqdn string
FQDN of vpn-site-link.
Id string
Resource ID.
IpAddress string
The ip-address for the vpn-site-link.
LinkProperties Pulumi.AzureNative.Network.Inputs.VpnLinkProviderPropertiesResponse
The link provider properties.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState This property is required. string
The provisioning state of the VPN site link resource.
Type This property is required. string
Resource type.
BgpProperties VpnLinkBgpSettingsResponse
The set of bgp properties.
Fqdn string
FQDN of vpn-site-link.
Id string
Resource ID.
IpAddress string
The ip-address for the vpn-site-link.
LinkProperties VpnLinkProviderPropertiesResponse
The link provider properties.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. String
The provisioning state of the VPN site link resource.
type This property is required. String
Resource type.
bgpProperties VpnLinkBgpSettingsResponse
The set of bgp properties.
fqdn String
FQDN of vpn-site-link.
id String
Resource ID.
ipAddress String
The ip-address for the vpn-site-link.
linkProperties VpnLinkProviderPropertiesResponse
The link provider properties.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. string
The provisioning state of the VPN site link resource.
type This property is required. string
Resource type.
bgpProperties VpnLinkBgpSettingsResponse
The set of bgp properties.
fqdn string
FQDN of vpn-site-link.
id string
Resource ID.
ipAddress string
The ip-address for the vpn-site-link.
linkProperties VpnLinkProviderPropertiesResponse
The link provider properties.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag This property is required. str
A unique read-only string that changes whenever the resource is updated.
provisioning_state This property is required. str
The provisioning state of the VPN site link resource.
type This property is required. str
Resource type.
bgp_properties VpnLinkBgpSettingsResponse
The set of bgp properties.
fqdn str
FQDN of vpn-site-link.
id str
Resource ID.
ip_address str
The ip-address for the vpn-site-link.
link_properties VpnLinkProviderPropertiesResponse
The link provider properties.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. String
The provisioning state of the VPN site link resource.
type This property is required. String
Resource type.
bgpProperties Property Map
The set of bgp properties.
fqdn String
FQDN of vpn-site-link.
id String
Resource ID.
ipAddress String
The ip-address for the vpn-site-link.
linkProperties Property Map
The link provider properties.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.

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 v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native