azure-native.network.getVpnSite
Explore with Pulumi AI
Retrieves the details of a VPN site.
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 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>
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]
func LookupVpnSite(ctx *Context, args *LookupVpnSiteArgs, opts ...InvokeOption) (*LookupVpnSiteResult, error)
func LookupVpnSiteOutput(ctx *Context, args *LookupVpnSiteOutputArgs, opts ...InvokeOption) LookupVpnSiteResultOutput
> 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)
}
public static CompletableFuture<GetVpnSiteResult> getVpnSite(GetVpnSiteArgs args, InvokeOptions options)
public static Output<GetVpnSiteResult> getVpnSite(GetVpnSiteArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:network:getVpnSite
arguments:
# arguments dictionary
The following arguments are supported:
- Resource
Group stringName - The resource group name of the VpnSite.
- Vpn
Site stringName - The name of the VpnSite being retrieved.
- Resource
Group stringName - The resource group name of the VpnSite.
- Vpn
Site stringName - The name of the VpnSite being retrieved.
- resource
Group StringName - The resource group name of the VpnSite.
- vpn
Site StringName - The name of the VpnSite being retrieved.
- resource
Group stringName - The resource group name of the VpnSite.
- vpn
Site stringName - The name of the VpnSite being retrieved.
- resource_
group_ strname - The resource group name of the VpnSite.
- vpn_
site_ strname - The name of the VpnSite being retrieved.
- resource
Group StringName - The resource group name of the VpnSite.
- vpn
Site StringName - The name of the VpnSite being retrieved.
getVpnSite Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Etag string
- A unique read-only string that changes whenever the resource is updated.
- Location string
- Resource location.
- Name string
- Resource name.
- Provisioning
State string - The provisioning state of the VPN site resource.
- Type string
- Resource type.
- Address
Space Pulumi.Azure Native. Network. Outputs. Address Space Response - The AddressSpace that contains an array of IP address ranges.
- Bgp
Properties Pulumi.Azure Native. Network. Outputs. Bgp Settings Response - The set of bgp properties.
- Device
Properties Pulumi.Azure Native. Network. Outputs. Device Properties Response - The device properties.
- Id string
- Resource ID.
- Ip
Address string - The ip-address for the vpn-site.
- Is
Security boolSite - IsSecuritySite flag.
- O365Policy
Pulumi.
Azure Native. Network. Outputs. O365Policy Properties Response - Office365 Policy.
- Site
Key string - The key for vpn-site that can be used for connections.
- Dictionary<string, string>
- Resource tags.
- Virtual
Wan Pulumi.Azure Native. Network. Outputs. Sub Resource Response - The VirtualWAN to which the vpnSite belongs.
- Vpn
Site List<Pulumi.Links Azure Native. Network. Outputs. Vpn Site Link Response> - List of all vpn site links.
- Azure
Api stringVersion - The Azure API version of the resource.
- Etag string
- A unique read-only string that changes whenever the resource is updated.
- Location string
- Resource location.
- Name string
- Resource name.
- Provisioning
State string - The provisioning state of the VPN site resource.
- Type string
- Resource type.
- Address
Space AddressSpace Response - The AddressSpace that contains an array of IP address ranges.
- Bgp
Properties BgpSettings Response - The set of bgp properties.
- Device
Properties DeviceProperties Response - The device properties.
- Id string
- Resource ID.
- Ip
Address string - The ip-address for the vpn-site.
- Is
Security boolSite - IsSecuritySite flag.
- O365Policy
O365Policy
Properties Response - Office365 Policy.
- Site
Key string - The key for vpn-site that can be used for connections.
- map[string]string
- Resource tags.
- Virtual
Wan SubResource Response - The VirtualWAN to which the vpnSite belongs.
- Vpn
Site []VpnLinks Site Link Response - List of all vpn site links.
- azure
Api StringVersion - The Azure API version of the resource.
- etag String
- A unique read-only string that changes whenever the resource is updated.
- location String
- Resource location.
- name String
- Resource name.
- provisioning
State String - The provisioning state of the VPN site resource.
- type String
- Resource type.
- address
Space AddressSpace Response - The AddressSpace that contains an array of IP address ranges.
- bgp
Properties BgpSettings Response - The set of bgp properties.
- device
Properties DeviceProperties Response - The device properties.
- id String
- Resource ID.
- ip
Address String - The ip-address for the vpn-site.
- is
Security BooleanSite - IsSecuritySite flag.
- o365Policy
O365Policy
Properties Response - Office365 Policy.
- site
Key String - The key for vpn-site that can be used for connections.
- Map<String,String>
- Resource tags.
- virtual
Wan SubResource Response - The VirtualWAN to which the vpnSite belongs.
- vpn
Site List<VpnLinks Site Link Response> - List of all vpn site links.
- azure
Api stringVersion - The Azure API version of the resource.
- etag string
- A unique read-only string that changes whenever the resource is updated.
- location string
- Resource location.
- name string
- Resource name.
- provisioning
State string - The provisioning state of the VPN site resource.
- type string
- Resource type.
- address
Space AddressSpace Response - The AddressSpace that contains an array of IP address ranges.
- bgp
Properties BgpSettings Response - The set of bgp properties.
- device
Properties DeviceProperties Response - The device properties.
- id string
- Resource ID.
- ip
Address string - The ip-address for the vpn-site.
- is
Security booleanSite - IsSecuritySite flag.
- o365Policy
O365Policy
Properties Response - Office365 Policy.
- site
Key string - The key for vpn-site that can be used for connections.
- {[key: string]: string}
- Resource tags.
- virtual
Wan SubResource Response - The VirtualWAN to which the vpnSite belongs.
- vpn
Site VpnLinks Site Link Response[] - List of all vpn site links.
- azure_
api_ strversion - The Azure API version of the resource.
- 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 AddressSpace Response - The AddressSpace that contains an array of IP address ranges.
- bgp_
properties BgpSettings Response - The set of bgp properties.
- device_
properties DeviceProperties Response - The device properties.
- id str
- Resource ID.
- ip_
address str - The ip-address for the vpn-site.
- is_
security_ boolsite - IsSecuritySite flag.
- o365_
policy O365PolicyProperties Response - Office365 Policy.
- site_
key str - The key for vpn-site that can be used for connections.
- Mapping[str, str]
- Resource tags.
- virtual_
wan SubResource Response - The VirtualWAN to which the vpnSite belongs.
- vpn_
site_ Sequence[Vpnlinks Site Link Response] - List of all vpn site links.
- azure
Api StringVersion - The Azure API version of the resource.
- etag String
- A unique read-only string that changes whenever the resource is updated.
- location String
- Resource location.
- name String
- Resource name.
- provisioning
State String - The provisioning state of the VPN site resource.
- type String
- Resource type.
- address
Space Property Map - The AddressSpace that contains an array of IP address ranges.
- bgp
Properties Property Map - The set of bgp properties.
- device
Properties Property Map - The device properties.
- id String
- Resource ID.
- ip
Address String - The ip-address for the vpn-site.
- is
Security BooleanSite - IsSecuritySite flag.
- o365Policy Property Map
- Office365 Policy.
- site
Key String - The key for vpn-site that can be used for connections.
- Map<String>
- Resource tags.
- virtual
Wan Property Map - The VirtualWAN to which the vpnSite belongs.
- vpn
Site List<Property Map>Links - List of all vpn site links.
Supporting Types
AddressSpaceResponse
- Address
Prefixes List<string> - A list of address blocks reserved for this virtual network in CIDR notation.
- Ipam
Pool List<Pulumi.Prefix Allocations Azure Native. Network. Inputs. Ipam Pool Prefix Allocation Response> - A list of IPAM Pools allocating IP address prefixes.
- Address
Prefixes []string - A list of address blocks reserved for this virtual network in CIDR notation.
- Ipam
Pool []IpamPrefix Allocations Pool Prefix Allocation Response - A list of IPAM Pools allocating IP address prefixes.
- address
Prefixes List<String> - A list of address blocks reserved for this virtual network in CIDR notation.
- ipam
Pool List<IpamPrefix Allocations Pool Prefix Allocation Response> - A list of IPAM Pools allocating IP address prefixes.
- address
Prefixes string[] - A list of address blocks reserved for this virtual network in CIDR notation.
- ipam
Pool IpamPrefix Allocations Pool Prefix Allocation Response[] - A list of IPAM Pools allocating IP address prefixes.
- address_
prefixes Sequence[str] - A list of address blocks reserved for this virtual network in CIDR notation.
- ipam_
pool_ Sequence[Ipamprefix_ allocations Pool Prefix Allocation Response] - A list of IPAM Pools allocating IP address prefixes.
- address
Prefixes List<String> - A list of address blocks reserved for this virtual network in CIDR notation.
- ipam
Pool List<Property Map>Prefix Allocations - A list of IPAM Pools allocating IP address prefixes.
BgpSettingsResponse
- Asn double
- The BGP speaker's ASN.
- Bgp
Peering stringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- Bgp
Peering List<Pulumi.Addresses Azure Native. Network. Inputs. IPConfiguration Bgp Peering Address Response> - 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 float64
- The BGP speaker's ASN.
- Bgp
Peering stringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- Bgp
Peering []IPConfigurationAddresses Bgp Peering Address Response - 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 Double
- The BGP speaker's ASN.
- bgp
Peering StringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- bgp
Peering List<IPConfigurationAddresses Bgp Peering Address Response> - BGP peering address with IP configuration ID for virtual network gateway.
- peer
Weight Integer - The weight added to routes learned from this BGP speaker.
- asn number
- The BGP speaker's ASN.
- bgp
Peering stringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- bgp
Peering IPConfigurationAddresses Bgp Peering Address Response[] - BGP peering address with IP configuration ID for virtual network gateway.
- peer
Weight number - The weight added to routes learned from this BGP speaker.
- asn float
- The BGP speaker's ASN.
- bgp_
peering_ straddress - The BGP peering address and BGP identifier of this BGP speaker.
- bgp_
peering_ Sequence[IPConfigurationaddresses Bgp Peering Address Response] - 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.
- bgp
Peering StringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- bgp
Peering List<Property Map>Addresses - BGP peering address with IP configuration ID for virtual network gateway.
- peer
Weight Number - The weight added to routes learned from this BGP speaker.
DevicePropertiesResponse
- Device
Model string - Model of the device.
- Device
Vendor string - Name of the device Vendor.
- Link
Speed intIn Mbps - Link speed.
- Device
Model string - Model of the device.
- Device
Vendor string - Name of the device Vendor.
- Link
Speed intIn Mbps - Link speed.
- device
Model String - Model of the device.
- device
Vendor String - Name of the device Vendor.
- link
Speed IntegerIn Mbps - Link speed.
- device
Model string - Model of the device.
- device
Vendor string - Name of the device Vendor.
- link
Speed numberIn Mbps - Link speed.
- device_
model str - Model of the device.
- device_
vendor str - Name of the device Vendor.
- link_
speed_ intin_ mbps - Link speed.
- device
Model String - Model of the device.
- device
Vendor String - Name of the device Vendor.
- link
Speed NumberIn Mbps - Link speed.
IPConfigurationBgpPeeringAddressResponse
- Default
Bgp List<string>Ip Addresses - The list of default BGP peering addresses which belong to IP configuration.
- Tunnel
Ip List<string>Addresses - The list of tunnel public IP addresses which belong to IP configuration.
- Custom
Bgp List<string>Ip Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- Ipconfiguration
Id string - The ID of IP configuration which belongs to gateway.
- Default
Bgp []stringIp Addresses - The list of default BGP peering addresses which belong to IP configuration.
- Tunnel
Ip []stringAddresses - The list of tunnel public IP addresses which belong to IP configuration.
- Custom
Bgp []stringIp Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- Ipconfiguration
Id string - The ID of IP configuration which belongs to gateway.
- default
Bgp List<String>Ip Addresses - The list of default BGP peering addresses which belong to IP configuration.
- tunnel
Ip List<String>Addresses - The list of tunnel public IP addresses which belong to IP configuration.
- custom
Bgp List<String>Ip Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- ipconfiguration
Id String - The ID of IP configuration which belongs to gateway.
- default
Bgp string[]Ip Addresses - The list of default BGP peering addresses which belong to IP configuration.
- tunnel
Ip string[]Addresses - The list of tunnel public IP addresses which belong to IP configuration.
- custom
Bgp string[]Ip Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- ipconfiguration
Id string - The ID of IP configuration which belongs to gateway.
- default_
bgp_ Sequence[str]ip_ addresses - The list of default BGP peering addresses which belong to IP configuration.
- tunnel_
ip_ Sequence[str]addresses - The list of tunnel public IP addresses which belong to IP configuration.
- custom_
bgp_ Sequence[str]ip_ addresses - The list of custom BGP peering addresses which belong to IP configuration.
- ipconfiguration_
id str - The ID of IP configuration which belongs to gateway.
- default
Bgp List<String>Ip Addresses - The list of default BGP peering addresses which belong to IP configuration.
- tunnel
Ip List<String>Addresses - The list of tunnel public IP addresses which belong to IP configuration.
- custom
Bgp List<String>Ip Addresses - The list of custom BGP peering addresses which belong to IP configuration.
- ipconfiguration
Id String - The ID of IP configuration which belongs to gateway.
IpamPoolPrefixAllocationResponse
- Allocated
Address List<string>Prefixes - List of assigned IP address prefixes in the IpamPool of the associated resource.
- Id string
- Resource id of the associated Azure IpamPool resource.
- Number
Of stringIp Addresses - Number of IP addresses to allocate.
- Allocated
Address []stringPrefixes - List of assigned IP address prefixes in the IpamPool of the associated resource.
- Id string
- Resource id of the associated Azure IpamPool resource.
- Number
Of stringIp Addresses - Number of IP addresses to allocate.
- allocated
Address List<String>Prefixes - List of assigned IP address prefixes in the IpamPool of the associated resource.
- id String
- Resource id of the associated Azure IpamPool resource.
- number
Of StringIp Addresses - Number of IP addresses to allocate.
- allocated
Address string[]Prefixes - List of assigned IP address prefixes in the IpamPool of the associated resource.
- id string
- Resource id of the associated Azure IpamPool resource.
- number
Of stringIp Addresses - Number of IP addresses to allocate.
- allocated_
address_ Sequence[str]prefixes - List of assigned IP address prefixes in the IpamPool of the associated resource.
- id str
- Resource id of the associated Azure IpamPool resource.
- number_
of_ strip_ addresses - Number of IP addresses to allocate.
- allocated
Address List<String>Prefixes - List of assigned IP address prefixes in the IpamPool of the associated resource.
- id String
- Resource id of the associated Azure IpamPool resource.
- number
Of StringIp Addresses - Number of IP addresses to allocate.
O365BreakOutCategoryPoliciesResponse
O365PolicyPropertiesResponse
- Break
Out Pulumi.Categories Azure Native. Network. Inputs. O365Break Out Category Policies Response - Office365 breakout categories.
- Break
Out O365BreakCategories Out Category Policies Response - Office365 breakout categories.
- break
Out O365BreakCategories Out Category Policies Response - Office365 breakout categories.
- break
Out O365BreakCategories Out Category Policies Response - Office365 breakout categories.
- break_
out_ O365Breakcategories Out Category Policies Response - Office365 breakout categories.
- break
Out Property MapCategories - Office365 breakout categories.
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.
VpnLinkBgpSettingsResponse
- Asn double
- The BGP speaker's ASN.
- Bgp
Peering stringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- Asn float64
- The BGP speaker's ASN.
- Bgp
Peering stringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- asn Double
- The BGP speaker's ASN.
- bgp
Peering StringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- asn number
- The BGP speaker's ASN.
- bgp
Peering stringAddress - The BGP peering address and BGP identifier of this BGP speaker.
- asn float
- The BGP speaker's ASN.
- bgp_
peering_ straddress - The BGP peering address and BGP identifier of this BGP speaker.
- asn Number
- The BGP speaker's ASN.
- bgp
Peering StringAddress - The BGP peering address and BGP identifier of this BGP speaker.
VpnLinkProviderPropertiesResponse
- Link
Provider stringName - Name of the link provider.
- Link
Speed intIn Mbps - Link speed.
- Link
Provider stringName - Name of the link provider.
- Link
Speed intIn Mbps - Link speed.
- link
Provider StringName - Name of the link provider.
- link
Speed IntegerIn Mbps - Link speed.
- link
Provider stringName - Name of the link provider.
- link
Speed numberIn Mbps - Link speed.
- link_
provider_ strname - Name of the link provider.
- link_
speed_ intin_ mbps - Link speed.
- link
Provider StringName - Name of the link provider.
- link
Speed NumberIn Mbps - Link speed.
VpnSiteLinkResponse
- Etag string
- A unique read-only string that changes whenever the resource is updated.
- Provisioning
State string - The provisioning state of the VPN site link resource.
- Type string
- Resource type.
- Bgp
Properties Pulumi.Azure Native. Network. Inputs. Vpn Link Bgp Settings Response - The set of bgp properties.
- Fqdn string
- FQDN of vpn-site-link.
- Id string
- Resource ID.
- Ip
Address string - The ip-address for the vpn-site-link.
- Link
Properties Pulumi.Azure Native. Network. Inputs. Vpn Link Provider Properties Response - 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 string
- A unique read-only string that changes whenever the resource is updated.
- Provisioning
State string - The provisioning state of the VPN site link resource.
- Type string
- Resource type.
- Bgp
Properties VpnLink Bgp Settings Response - The set of bgp properties.
- Fqdn string
- FQDN of vpn-site-link.
- Id string
- Resource ID.
- Ip
Address string - The ip-address for the vpn-site-link.
- Link
Properties VpnLink Provider Properties Response - 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 String
- A unique read-only string that changes whenever the resource is updated.
- provisioning
State String - The provisioning state of the VPN site link resource.
- type String
- Resource type.
- bgp
Properties VpnLink Bgp Settings Response - The set of bgp properties.
- fqdn String
- FQDN of vpn-site-link.
- id String
- Resource ID.
- ip
Address String - The ip-address for the vpn-site-link.
- link
Properties VpnLink Provider Properties Response - 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 string
- A unique read-only string that changes whenever the resource is updated.
- provisioning
State string - The provisioning state of the VPN site link resource.
- type string
- Resource type.
- bgp
Properties VpnLink Bgp Settings Response - The set of bgp properties.
- fqdn string
- FQDN of vpn-site-link.
- id string
- Resource ID.
- ip
Address string - The ip-address for the vpn-site-link.
- link
Properties VpnLink Provider Properties Response - 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 str
- A unique read-only string that changes whenever the resource is updated.
- provisioning_
state str - The provisioning state of the VPN site link resource.
- type str
- Resource type.
- bgp_
properties VpnLink Bgp Settings Response - 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 VpnLink Provider Properties Response - 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 String
- A unique read-only string that changes whenever the resource is updated.
- provisioning
State String - The provisioning state of the VPN site link resource.
- type String
- Resource type.
- bgp
Properties Property Map - The set of bgp properties.
- fqdn String
- FQDN of vpn-site-link.
- id String
- Resource ID.
- ip
Address String - The ip-address for the vpn-site-link.
- link
Properties 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