We recommend using Azure Native.
Azure v6.28.0 published on Friday, Oct 3, 2025 by Pulumi
azure.network.getVpnServerConfiguration
Start a Neo task
Explain and create an azure.network.getVpnServerConfiguration resource
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.id());
}
}
variables:
example:
fn::invoke:
function: azure:network:getVpnServerConfiguration
arguments:
name: existing-local-vpn-server-configuration
resourceGroupName: existing-resource-group
outputs:
azurermVpnServerConfiguration: ${example.id}
API Providers
This data source uses the following Azure API Providers:
Microsoft.Network- 2024-05-01
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.
- Resource
Group stringName - The name of the Resource Group where the VPN Server Configuration exists.
- Name string
- The Name of the VPN Server Configuration.
- Resource
Group stringName - The name of the Resource Group where the VPN Server Configuration exists.
- name String
- The Name of the VPN Server Configuration.
- resource
Group StringName - The name of the Resource Group where the VPN Server Configuration exists.
- name string
- The Name of the VPN Server Configuration.
- resource
Group 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.
- resource
Group StringName - The name of the Resource Group where the VPN Server Configuration exists.
getVpnServerConfiguration Result
The following output properties are available:
- Azure
Active List<GetDirectory Authentications Vpn Server Configuration Azure Active Directory Authentication> - A
azure_active_directory_authenticationblock as defined below. - Client
Revoked List<GetCertificates Vpn Server Configuration Client Revoked Certificate> - One or more
client_revoked_certificateblocks as defined below. - Client
Root 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.
- Ipsec
Policies 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<Get
Vpn Server Configuration Radius> - A
radiusblock as defined below. - Resource
Group stringName - Dictionary<string, string>
- A mapping of tags to assign to the VPN Server Configuration.
- Vpn
Authentication List<string>Types - The list of Authentication Types applicable for the VPN Server Configuration.
- Vpn
Protocols List<string> - The list of VPN Protocols to use for the VPN Server Configuration.
- Azure
Active []GetDirectory Authentications Vpn Server Configuration Azure Active Directory Authentication - A
azure_active_directory_authenticationblock as defined below. - Client
Revoked []GetCertificates Vpn Server Configuration Client Revoked Certificate - One or more
client_revoked_certificateblocks as defined below. - Client
Root []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.
- Ipsec
Policies []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
[]Get
Vpn Server Configuration Radius - A
radiusblock as defined below. - Resource
Group stringName - map[string]string
- A mapping of tags to assign to the VPN Server Configuration.
- Vpn
Authentication []stringTypes - The list of Authentication Types applicable for the VPN Server Configuration.
- Vpn
Protocols []string - The list of VPN Protocols to use for the VPN Server Configuration.
- azure
Active List<GetDirectory Authentications Vpn Server Configuration Azure Active Directory Authentication> - A
azure_active_directory_authenticationblock as defined below. - client
Revoked List<GetCertificates Vpn Server Configuration Client Revoked Certificate> - One or more
client_revoked_certificateblocks as defined below. - client
Root 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.
- ipsec
Policies 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<Get
Vpn Server Configuration Radius> - A
radiusblock as defined below. - resource
Group StringName - Map<String,String>
- A mapping of tags to assign to the VPN Server Configuration.
- vpn
Authentication List<String>Types - The list of Authentication Types applicable for the VPN Server Configuration.
- vpn
Protocols List<String> - The list of VPN Protocols to use for the VPN Server Configuration.
- azure
Active GetDirectory Authentications Vpn Server Configuration Azure Active Directory Authentication[] - A
azure_active_directory_authenticationblock as defined below. - client
Revoked GetCertificates Vpn Server Configuration Client Revoked Certificate[] - One or more
client_revoked_certificateblocks as defined below. - client
Root 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.
- ipsec
Policies 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
Get
Vpn Server Configuration Radius[] - A
radiusblock as defined below. - resource
Group stringName - {[key: string]: string}
- A mapping of tags to assign to the VPN Server Configuration.
- vpn
Authentication string[]Types - The list of Authentication Types applicable for the VPN Server Configuration.
- vpn
Protocols 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[Get
Vpn 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.
- azure
Active List<Property Map>Directory Authentications - A
azure_active_directory_authenticationblock as defined below. - client
Revoked List<Property Map>Certificates - One or more
client_revoked_certificateblocks as defined below. - client
Root List<Property Map>Certificates - One or more
client_root_certificateblocks as defined below. - id String
- The provider-assigned unique ID for this managed resource.
- ipsec
Policies 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. - resource
Group StringName - Map<String>
- A mapping of tags to assign to the VPN Server Configuration.
- vpn
Authentication List<String>Types - The list of Authentication Types applicable for the VPN Server Configuration.
- vpn
Protocols 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.
- Public
Cert stringData - The Public Key Data associated with the Certificate.
- Name string
- The Name of the VPN Server Configuration.
- Public
Cert stringData - The Public Key Data associated with the Certificate.
- name String
- The Name of the VPN Server Configuration.
- public
Cert StringData - The Public Key Data associated with the Certificate.
- name string
- The Name of the VPN Server Configuration.
- public
Cert 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.
- public
Cert StringData - The Public Key Data associated with the Certificate.
GetVpnServerConfigurationIpsecPolicy
- Dh
Group string - The DH Group, used in IKE Phase 1.
- Ike
Encryption string - The IKE encryption algorithm, used for IKE Phase 2.
- Ike
Integrity string - The IKE encryption integrity algorithm, used for IKE Phase 2.
- Ipsec
Encryption string - The IPSec encryption algorithm, used for IKE phase 1.
- Ipsec
Integrity string - The IPSec integrity algorithm, used for IKE phase 1.
- Pfs
Group string - 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.
- Dh
Group string - The DH Group, used in IKE Phase 1.
- Ike
Encryption string - The IKE encryption algorithm, used for IKE Phase 2.
- Ike
Integrity string - The IKE encryption integrity algorithm, used for IKE Phase 2.
- Ipsec
Encryption string - The IPSec encryption algorithm, used for IKE phase 1.
- Ipsec
Integrity string - The IPSec integrity algorithm, used for IKE phase 1.
- Pfs
Group string - 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.
- dh
Group String - The DH Group, used in IKE Phase 1.
- ike
Encryption String - The IKE encryption algorithm, used for IKE Phase 2.
- ike
Integrity String - The IKE encryption integrity algorithm, used for IKE Phase 2.
- ipsec
Encryption String - The IPSec encryption algorithm, used for IKE phase 1.
- ipsec
Integrity String - The IPSec integrity algorithm, used for IKE phase 1.
- pfs
Group String - The Pfs Group, used in IKE Phase 2.
- sa
Data IntegerSize Kilobytes - The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.
- sa
Lifetime IntegerSeconds - The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.
- dh
Group string - The DH Group, used in IKE Phase 1.
- ike
Encryption string - The IKE encryption algorithm, used for IKE Phase 2.
- ike
Integrity string - The IKE encryption integrity algorithm, used for IKE Phase 2.
- ipsec
Encryption string - The IPSec encryption algorithm, used for IKE phase 1.
- ipsec
Integrity string - The IPSec integrity algorithm, used for IKE phase 1.
- pfs
Group string - The Pfs Group, used in IKE Phase 2.
- sa
Data numberSize Kilobytes - The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.
- sa
Lifetime 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.
- dh
Group String - The DH Group, used in IKE Phase 1.
- ike
Encryption String - The IKE encryption algorithm, used for IKE Phase 2.
- ike
Integrity String - The IKE encryption integrity algorithm, used for IKE Phase 2.
- ipsec
Encryption String - The IPSec encryption algorithm, used for IKE phase 1.
- ipsec
Integrity String - The IPSec integrity algorithm, used for IKE phase 1.
- pfs
Group String - The Pfs Group, used in IKE Phase 2.
- sa
Data NumberSize Kilobytes - The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.
- sa
Lifetime NumberSeconds - The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.
GetVpnServerConfigurationRadius
- Client
Root List<GetCertificates Vpn Server Configuration Radius Client Root Certificate> - One or more
client_root_certificateblocks as defined below. - Server
Root List<GetCertificates Vpn Server Configuration Radius Server Root Certificate> - One or more
server_root_certificateblocks as defined below. - Servers
List<Get
Vpn Server Configuration Radius Server> - One or more
serverblocks as defined below.
- Client
Root []GetCertificates Vpn Server Configuration Radius Client Root Certificate - One or more
client_root_certificateblocks as defined below. - Server
Root []GetCertificates Vpn Server Configuration Radius Server Root Certificate - One or more
server_root_certificateblocks as defined below. - Servers
[]Get
Vpn Server Configuration Radius Server - One or more
serverblocks as defined below.
- client
Root List<GetCertificates Vpn Server Configuration Radius Client Root Certificate> - One or more
client_root_certificateblocks as defined below. - server
Root List<GetCertificates Vpn Server Configuration Radius Server Root Certificate> - One or more
server_root_certificateblocks as defined below. - servers
List<Get
Vpn Server Configuration Radius Server> - One or more
serverblocks as defined below.
- client
Root GetCertificates Vpn Server Configuration Radius Client Root Certificate[] - One or more
client_root_certificateblocks as defined below. - server
Root GetCertificates Vpn Server Configuration Radius Server Root Certificate[] - One or more
server_root_certificateblocks as defined below. - servers
Get
Vpn 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[Get
Vpn Server Configuration Radius Server] - One or more
serverblocks as defined below.
- client
Root List<Property Map>Certificates - One or more
client_root_certificateblocks as defined below. - server
Root 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.
- Public
Cert stringData - The Public Key Data associated with the Certificate.
- Name string
- The Name of the VPN Server Configuration.
- Public
Cert stringData - The Public Key Data associated with the Certificate.
- name String
- The Name of the VPN Server Configuration.
- public
Cert StringData - The Public Key Data associated with the Certificate.
- name string
- The Name of the VPN Server Configuration.
- public
Cert 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.
- public
Cert 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.
