We recommend using Azure Native.
Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
azure.network.getVpnServerConfiguration
Explore with Pulumi AI
Use this data source to access information about an existing VPN Server Configuration.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.network.getVpnServerConfiguration({
    name: "existing-local-vpn-server-configuration",
    resourceGroupName: "existing-resource-group",
});
export const azurermVpnServerConfiguration = example.then(example => example.id);
import pulumi
import pulumi_azure as azure
example = azure.network.get_vpn_server_configuration(name="existing-local-vpn-server-configuration",
    resource_group_name="existing-resource-group")
pulumi.export("azurermVpnServerConfiguration", example.id)
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := network.LookupVpnServerConfiguration(ctx, &network.LookupVpnServerConfigurationArgs{
			Name:              "existing-local-vpn-server-configuration",
			ResourceGroupName: "existing-resource-group",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("azurermVpnServerConfiguration", example.Id)
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() => 
{
    var example = Azure.Network.GetVpnServerConfiguration.Invoke(new()
    {
        Name = "existing-local-vpn-server-configuration",
        ResourceGroupName = "existing-resource-group",
    });
    return new Dictionary<string, object?>
    {
        ["azurermVpnServerConfiguration"] = example.Apply(getVpnServerConfigurationResult => getVpnServerConfigurationResult.Id),
    };
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.network.NetworkFunctions;
import com.pulumi.azure.network.inputs.GetVpnServerConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var example = NetworkFunctions.getVpnServerConfiguration(GetVpnServerConfigurationArgs.builder()
            .name("existing-local-vpn-server-configuration")
            .resourceGroupName("existing-resource-group")
            .build());
        ctx.export("azurermVpnServerConfiguration", example.applyValue(getVpnServerConfigurationResult -> getVpnServerConfigurationResult.id()));
    }
}
variables:
  example:
    fn::invoke:
      function: azure:network:getVpnServerConfiguration
      arguments:
        name: existing-local-vpn-server-configuration
        resourceGroupName: existing-resource-group
outputs:
  azurermVpnServerConfiguration: ${example.id}
Using getVpnServerConfiguration
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 getVpnServerConfiguration(args: GetVpnServerConfigurationArgs, opts?: InvokeOptions): Promise<GetVpnServerConfigurationResult>
function getVpnServerConfigurationOutput(args: GetVpnServerConfigurationOutputArgs, opts?: InvokeOptions): Output<GetVpnServerConfigurationResult>def get_vpn_server_configuration(name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetVpnServerConfigurationResult
def get_vpn_server_configuration_output(name: Optional[pulumi.Input[str]] = None,
                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetVpnServerConfigurationResult]func LookupVpnServerConfiguration(ctx *Context, args *LookupVpnServerConfigurationArgs, opts ...InvokeOption) (*LookupVpnServerConfigurationResult, error)
func LookupVpnServerConfigurationOutput(ctx *Context, args *LookupVpnServerConfigurationOutputArgs, opts ...InvokeOption) LookupVpnServerConfigurationResultOutput> Note: This function is named LookupVpnServerConfiguration in the Go SDK.
public static class GetVpnServerConfiguration 
{
    public static Task<GetVpnServerConfigurationResult> InvokeAsync(GetVpnServerConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetVpnServerConfigurationResult> Invoke(GetVpnServerConfigurationInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetVpnServerConfigurationResult> getVpnServerConfiguration(GetVpnServerConfigurationArgs args, InvokeOptions options)
public static Output<GetVpnServerConfigurationResult> getVpnServerConfiguration(GetVpnServerConfigurationArgs args, InvokeOptions options)
fn::invoke:
  function: azure:network/getVpnServerConfiguration:getVpnServerConfiguration
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Name string
- The Name of the VPN Server Configuration.
- ResourceGroup stringName 
- The name of the Resource Group where the VPN Server Configuration exists.
- Name string
- The Name of the VPN Server Configuration.
- ResourceGroup stringName 
- The name of the Resource Group where the VPN Server Configuration exists.
- name String
- The Name of the VPN Server Configuration.
- resourceGroup StringName 
- The name of the Resource Group where the VPN Server Configuration exists.
- name string
- The Name of the VPN Server Configuration.
- resourceGroup stringName 
- The name of the Resource Group where the VPN Server Configuration exists.
- name str
- The Name of the VPN Server Configuration.
- resource_group_ strname 
- The name of the Resource Group where the VPN Server Configuration exists.
- name String
- The Name of the VPN Server Configuration.
- resourceGroup StringName 
- The name of the Resource Group where the VPN Server Configuration exists.
getVpnServerConfiguration Result
The following output properties are available:
- AzureActive List<GetDirectory Authentications Vpn Server Configuration Azure Active Directory Authentication> 
- A azure_active_directory_authenticationblock as defined below.
- ClientRevoked List<GetCertificates Vpn Server Configuration Client Revoked Certificate> 
- One or more client_revoked_certificateblocks as defined below.
- ClientRoot List<GetCertificates Vpn Server Configuration Client Root Certificate> 
- One or more client_root_certificateblocks as defined below.
- Id string
- The provider-assigned unique ID for this managed resource.
- IpsecPolicies List<GetVpn Server Configuration Ipsec Policy> 
- The bgp_settingsblock as defined below.
- Location string
- The Azure Region where the VPN Server Configuration exists.
- Name string
- The name used to uniquely identify this certificate.
- Radii
List<GetVpn Server Configuration Radius> 
- A radiusblock as defined below.
- ResourceGroup stringName 
- Dictionary<string, string>
- A mapping of tags to assign to the VPN Server Configuration.
- VpnAuthentication List<string>Types 
- The list of Authentication Types applicable for the VPN Server Configuration.
- VpnProtocols List<string>
- The list of VPN Protocols to use for the VPN Server Configuration.
- AzureActive []GetDirectory Authentications Vpn Server Configuration Azure Active Directory Authentication 
- A azure_active_directory_authenticationblock as defined below.
- ClientRevoked []GetCertificates Vpn Server Configuration Client Revoked Certificate 
- One or more client_revoked_certificateblocks as defined below.
- ClientRoot []GetCertificates Vpn Server Configuration Client Root Certificate 
- One or more client_root_certificateblocks as defined below.
- Id string
- The provider-assigned unique ID for this managed resource.
- IpsecPolicies []GetVpn Server Configuration Ipsec Policy 
- The bgp_settingsblock as defined below.
- Location string
- The Azure Region where the VPN Server Configuration exists.
- Name string
- The name used to uniquely identify this certificate.
- Radii
[]GetVpn Server Configuration Radius 
- A radiusblock as defined below.
- ResourceGroup stringName 
- map[string]string
- A mapping of tags to assign to the VPN Server Configuration.
- VpnAuthentication []stringTypes 
- The list of Authentication Types applicable for the VPN Server Configuration.
- VpnProtocols []string
- The list of VPN Protocols to use for the VPN Server Configuration.
- azureActive List<GetDirectory Authentications Vpn Server Configuration Azure Active Directory Authentication> 
- A azure_active_directory_authenticationblock as defined below.
- clientRevoked List<GetCertificates Vpn Server Configuration Client Revoked Certificate> 
- One or more client_revoked_certificateblocks as defined below.
- clientRoot List<GetCertificates Vpn Server Configuration Client Root Certificate> 
- One or more client_root_certificateblocks as defined below.
- id String
- The provider-assigned unique ID for this managed resource.
- ipsecPolicies List<GetVpn Server Configuration Ipsec Policy> 
- The bgp_settingsblock as defined below.
- location String
- The Azure Region where the VPN Server Configuration exists.
- name String
- The name used to uniquely identify this certificate.
- radii
List<GetVpn Server Configuration Radius> 
- A radiusblock as defined below.
- resourceGroup StringName 
- Map<String,String>
- A mapping of tags to assign to the VPN Server Configuration.
- vpnAuthentication List<String>Types 
- The list of Authentication Types applicable for the VPN Server Configuration.
- vpnProtocols List<String>
- The list of VPN Protocols to use for the VPN Server Configuration.
- azureActive GetDirectory Authentications Vpn Server Configuration Azure Active Directory Authentication[] 
- A azure_active_directory_authenticationblock as defined below.
- clientRevoked GetCertificates Vpn Server Configuration Client Revoked Certificate[] 
- One or more client_revoked_certificateblocks as defined below.
- clientRoot GetCertificates Vpn Server Configuration Client Root Certificate[] 
- One or more client_root_certificateblocks as defined below.
- id string
- The provider-assigned unique ID for this managed resource.
- ipsecPolicies GetVpn Server Configuration Ipsec Policy[] 
- The bgp_settingsblock as defined below.
- location string
- The Azure Region where the VPN Server Configuration exists.
- name string
- The name used to uniquely identify this certificate.
- radii
GetVpn Server Configuration Radius[] 
- A radiusblock as defined below.
- resourceGroup stringName 
- {[key: string]: string}
- A mapping of tags to assign to the VPN Server Configuration.
- vpnAuthentication string[]Types 
- The list of Authentication Types applicable for the VPN Server Configuration.
- vpnProtocols string[]
- The list of VPN Protocols to use for the VPN Server Configuration.
- azure_active_ Sequence[Getdirectory_ authentications Vpn Server Configuration Azure Active Directory Authentication] 
- A azure_active_directory_authenticationblock as defined below.
- client_revoked_ Sequence[Getcertificates Vpn Server Configuration Client Revoked Certificate] 
- One or more client_revoked_certificateblocks as defined below.
- client_root_ Sequence[Getcertificates Vpn Server Configuration Client Root Certificate] 
- One or more client_root_certificateblocks as defined below.
- id str
- The provider-assigned unique ID for this managed resource.
- ipsec_policies Sequence[GetVpn Server Configuration Ipsec Policy] 
- The bgp_settingsblock as defined below.
- location str
- The Azure Region where the VPN Server Configuration exists.
- name str
- The name used to uniquely identify this certificate.
- radii
Sequence[GetVpn Server Configuration Radius] 
- A radiusblock as defined below.
- resource_group_ strname 
- Mapping[str, str]
- A mapping of tags to assign to the VPN Server Configuration.
- vpn_authentication_ Sequence[str]types 
- The list of Authentication Types applicable for the VPN Server Configuration.
- vpn_protocols Sequence[str]
- The list of VPN Protocols to use for the VPN Server Configuration.
- azureActive List<Property Map>Directory Authentications 
- A azure_active_directory_authenticationblock as defined below.
- clientRevoked List<Property Map>Certificates 
- One or more client_revoked_certificateblocks as defined below.
- clientRoot List<Property Map>Certificates 
- One or more client_root_certificateblocks as defined below.
- id String
- The provider-assigned unique ID for this managed resource.
- ipsecPolicies List<Property Map>
- The bgp_settingsblock as defined below.
- location String
- The Azure Region where the VPN Server Configuration exists.
- name String
- The name used to uniquely identify this certificate.
- radii List<Property Map>
- A radiusblock as defined below.
- resourceGroup StringName 
- Map<String>
- A mapping of tags to assign to the VPN Server Configuration.
- vpnAuthentication List<String>Types 
- The list of Authentication Types applicable for the VPN Server Configuration.
- vpnProtocols List<String>
- The list of VPN Protocols to use for the VPN Server Configuration.
Supporting Types
GetVpnServerConfigurationAzureActiveDirectoryAuthentication       
GetVpnServerConfigurationClientRevokedCertificate      
- Name string
- The Name of the VPN Server Configuration.
- Thumbprint string
- The Thumbprint of the Certificate.
- Name string
- The Name of the VPN Server Configuration.
- Thumbprint string
- The Thumbprint of the Certificate.
- name String
- The Name of the VPN Server Configuration.
- thumbprint String
- The Thumbprint of the Certificate.
- name string
- The Name of the VPN Server Configuration.
- thumbprint string
- The Thumbprint of the Certificate.
- name str
- The Name of the VPN Server Configuration.
- thumbprint str
- The Thumbprint of the Certificate.
- name String
- The Name of the VPN Server Configuration.
- thumbprint String
- The Thumbprint of the Certificate.
GetVpnServerConfigurationClientRootCertificate      
- Name string
- The Name of the VPN Server Configuration.
- PublicCert stringData 
- The Public Key Data associated with the Certificate.
- Name string
- The Name of the VPN Server Configuration.
- PublicCert stringData 
- The Public Key Data associated with the Certificate.
- name String
- The Name of the VPN Server Configuration.
- publicCert StringData 
- The Public Key Data associated with the Certificate.
- name string
- The Name of the VPN Server Configuration.
- publicCert stringData 
- The Public Key Data associated with the Certificate.
- name str
- The Name of the VPN Server Configuration.
- public_cert_ strdata 
- The Public Key Data associated with the Certificate.
- name String
- The Name of the VPN Server Configuration.
- publicCert StringData 
- The Public Key Data associated with the Certificate.
GetVpnServerConfigurationIpsecPolicy     
- DhGroup string
- The DH Group, used in IKE Phase 1.
- IkeEncryption string
- The IKE encryption algorithm, used for IKE Phase 2.
- IkeIntegrity string
- The IKE encryption integrity algorithm, used for IKE Phase 2.
- IpsecEncryption string
- The IPSec encryption algorithm, used for IKE phase 1.
- IpsecIntegrity string
- The IPSec integrity algorithm, used for IKE phase 1.
- PfsGroup string
- The Pfs Group, used in IKE Phase 2.
- SaData intSize Kilobytes 
- The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.
- SaLifetime intSeconds 
- The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.
- DhGroup string
- The DH Group, used in IKE Phase 1.
- IkeEncryption string
- The IKE encryption algorithm, used for IKE Phase 2.
- IkeIntegrity string
- The IKE encryption integrity algorithm, used for IKE Phase 2.
- IpsecEncryption string
- The IPSec encryption algorithm, used for IKE phase 1.
- IpsecIntegrity string
- The IPSec integrity algorithm, used for IKE phase 1.
- PfsGroup string
- The Pfs Group, used in IKE Phase 2.
- SaData intSize Kilobytes 
- The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.
- SaLifetime intSeconds 
- The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.
- dhGroup String
- The DH Group, used in IKE Phase 1.
- ikeEncryption String
- The IKE encryption algorithm, used for IKE Phase 2.
- ikeIntegrity String
- The IKE encryption integrity algorithm, used for IKE Phase 2.
- ipsecEncryption String
- The IPSec encryption algorithm, used for IKE phase 1.
- ipsecIntegrity String
- The IPSec integrity algorithm, used for IKE phase 1.
- pfsGroup String
- The Pfs Group, used in IKE Phase 2.
- saData IntegerSize Kilobytes 
- The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.
- saLifetime IntegerSeconds 
- The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.
- dhGroup string
- The DH Group, used in IKE Phase 1.
- ikeEncryption string
- The IKE encryption algorithm, used for IKE Phase 2.
- ikeIntegrity string
- The IKE encryption integrity algorithm, used for IKE Phase 2.
- ipsecEncryption string
- The IPSec encryption algorithm, used for IKE phase 1.
- ipsecIntegrity string
- The IPSec integrity algorithm, used for IKE phase 1.
- pfsGroup string
- The Pfs Group, used in IKE Phase 2.
- saData numberSize Kilobytes 
- The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.
- saLifetime numberSeconds 
- The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.
- dh_group str
- The DH Group, used in IKE Phase 1.
- ike_encryption str
- The IKE encryption algorithm, used for IKE Phase 2.
- ike_integrity str
- The IKE encryption integrity algorithm, used for IKE Phase 2.
- ipsec_encryption str
- The IPSec encryption algorithm, used for IKE phase 1.
- ipsec_integrity str
- The IPSec integrity algorithm, used for IKE phase 1.
- pfs_group str
- The Pfs Group, used in IKE Phase 2.
- sa_data_ intsize_ kilobytes 
- The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.
- sa_lifetime_ intseconds 
- The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.
- dhGroup String
- The DH Group, used in IKE Phase 1.
- ikeEncryption String
- The IKE encryption algorithm, used for IKE Phase 2.
- ikeIntegrity String
- The IKE encryption integrity algorithm, used for IKE Phase 2.
- ipsecEncryption String
- The IPSec encryption algorithm, used for IKE phase 1.
- ipsecIntegrity String
- The IPSec integrity algorithm, used for IKE phase 1.
- pfsGroup String
- The Pfs Group, used in IKE Phase 2.
- saData NumberSize Kilobytes 
- The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.
- saLifetime NumberSeconds 
- The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.
GetVpnServerConfigurationRadius    
- ClientRoot List<GetCertificates Vpn Server Configuration Radius Client Root Certificate> 
- One or more client_root_certificateblocks as defined below.
- ServerRoot List<GetCertificates Vpn Server Configuration Radius Server Root Certificate> 
- One or more server_root_certificateblocks as defined below.
- Servers
List<GetVpn Server Configuration Radius Server> 
- One or more serverblocks as defined below.
- ClientRoot []GetCertificates Vpn Server Configuration Radius Client Root Certificate 
- One or more client_root_certificateblocks as defined below.
- ServerRoot []GetCertificates Vpn Server Configuration Radius Server Root Certificate 
- One or more server_root_certificateblocks as defined below.
- Servers
[]GetVpn Server Configuration Radius Server 
- One or more serverblocks as defined below.
- clientRoot List<GetCertificates Vpn Server Configuration Radius Client Root Certificate> 
- One or more client_root_certificateblocks as defined below.
- serverRoot List<GetCertificates Vpn Server Configuration Radius Server Root Certificate> 
- One or more server_root_certificateblocks as defined below.
- servers
List<GetVpn Server Configuration Radius Server> 
- One or more serverblocks as defined below.
- clientRoot GetCertificates Vpn Server Configuration Radius Client Root Certificate[] 
- One or more client_root_certificateblocks as defined below.
- serverRoot GetCertificates Vpn Server Configuration Radius Server Root Certificate[] 
- One or more server_root_certificateblocks as defined below.
- servers
GetVpn Server Configuration Radius Server[] 
- One or more serverblocks as defined below.
- client_root_ Sequence[Getcertificates Vpn Server Configuration Radius Client Root Certificate] 
- One or more client_root_certificateblocks as defined below.
- server_root_ Sequence[Getcertificates Vpn Server Configuration Radius Server Root Certificate] 
- One or more server_root_certificateblocks as defined below.
- servers
Sequence[GetVpn Server Configuration Radius Server] 
- One or more serverblocks as defined below.
- clientRoot List<Property Map>Certificates 
- One or more client_root_certificateblocks as defined below.
- serverRoot List<Property Map>Certificates 
- One or more server_root_certificateblocks as defined below.
- servers List<Property Map>
- One or more serverblocks as defined below.
GetVpnServerConfigurationRadiusClientRootCertificate       
- Name string
- The Name of the VPN Server Configuration.
- Thumbprint string
- The Thumbprint of the Certificate.
- Name string
- The Name of the VPN Server Configuration.
- Thumbprint string
- The Thumbprint of the Certificate.
- name String
- The Name of the VPN Server Configuration.
- thumbprint String
- The Thumbprint of the Certificate.
- name string
- The Name of the VPN Server Configuration.
- thumbprint string
- The Thumbprint of the Certificate.
- name str
- The Name of the VPN Server Configuration.
- thumbprint str
- The Thumbprint of the Certificate.
- name String
- The Name of the VPN Server Configuration.
- thumbprint String
- The Thumbprint of the Certificate.
GetVpnServerConfigurationRadiusServer     
GetVpnServerConfigurationRadiusServerRootCertificate       
- Name string
- The Name of the VPN Server Configuration.
- PublicCert stringData 
- The Public Key Data associated with the Certificate.
- Name string
- The Name of the VPN Server Configuration.
- PublicCert stringData 
- The Public Key Data associated with the Certificate.
- name String
- The Name of the VPN Server Configuration.
- publicCert StringData 
- The Public Key Data associated with the Certificate.
- name string
- The Name of the VPN Server Configuration.
- publicCert stringData 
- The Public Key Data associated with the Certificate.
- name str
- The Name of the VPN Server Configuration.
- public_cert_ strdata 
- The Public Key Data associated with the Certificate.
- name String
- The Name of the VPN Server Configuration.
- publicCert StringData 
- The Public Key Data associated with the Certificate.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the azurermTerraform Provider.