1. Docs
  2. Reference
  3. API
  4. Azure
  5. network
  6. VpnServerConfiguration

VpnServerConfiguration

Manages a VPN Server Configuration.

Create a VpnServerConfiguration Resource

new VpnServerConfiguration(name: string, args: VpnServerConfigurationArgs, opts?: CustomResourceOptions);
def VpnServerConfiguration(resource_name, opts=None, azure_active_directory_authentications=None, client_revoked_certificates=None, client_root_certificates=None, ipsec_policy=None, location=None, name=None, radius_server=None, resource_group_name=None, tags=None, vpn_authentication_types=None, vpn_protocols=None, __props__=None);
func NewVpnServerConfiguration(ctx *Context, name string, args VpnServerConfigurationArgs, opts ...ResourceOption) (*VpnServerConfiguration, error)
public VpnServerConfiguration(string name, VpnServerConfigurationArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args VpnServerConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args VpnServerConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args VpnServerConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

VpnServerConfiguration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The VpnServerConfiguration resource accepts the following input properties:

ResourceGroupName string

The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.

VpnAuthenticationTypes string

A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.

AzureActiveDirectoryAuthentications List<VpnServerConfigurationAzureActiveDirectoryAuthenticationArgs>

A azure_active_directory_authentication block as defined below.

ClientRevokedCertificates List<VpnServerConfigurationClientRevokedCertificateArgs>

One or more client_revoked_certificate blocks as defined below.

ClientRootCertificates List<VpnServerConfigurationClientRootCertificateArgs>

One or more client_root_certificate blocks as defined below.

IpsecPolicy VpnServerConfigurationIpsecPolicyArgs

A ipsec_policy block as defined below.

Location string

The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.

Name string

The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.

RadiusServer VpnServerConfigurationRadiusServerArgs

A radius_server block as defined below.

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

VpnProtocols List<string>

A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.

ResourceGroupName string

The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.

VpnAuthenticationTypes string

A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.

AzureActiveDirectoryAuthentications []VpnServerConfigurationAzureActiveDirectoryAuthentication

A azure_active_directory_authentication block as defined below.

ClientRevokedCertificates []VpnServerConfigurationClientRevokedCertificate

One or more client_revoked_certificate blocks as defined below.

ClientRootCertificates []VpnServerConfigurationClientRootCertificate

One or more client_root_certificate blocks as defined below.

IpsecPolicy VpnServerConfigurationIpsecPolicy

A ipsec_policy block as defined below.

Location string

The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.

Name string

The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.

RadiusServer VpnServerConfigurationRadiusServer

A radius_server block as defined below.

Tags map[string]string

A mapping of tags to assign to the resource.

VpnProtocols []string

A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.

resourceGroupName string

The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.

vpnAuthenticationTypes string

A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.

azureActiveDirectoryAuthentications VpnServerConfigurationAzureActiveDirectoryAuthentication[]

A azure_active_directory_authentication block as defined below.

clientRevokedCertificates VpnServerConfigurationClientRevokedCertificate[]

One or more client_revoked_certificate blocks as defined below.

clientRootCertificates VpnServerConfigurationClientRootCertificate[]

One or more client_root_certificate blocks as defined below.

ipsecPolicy VpnServerConfigurationIpsecPolicy

A ipsec_policy block as defined below.

location string

The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.

name string

The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.

radiusServer VpnServerConfigurationRadiusServer

A radius_server block as defined below.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

vpnProtocols string[]

A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.

resource_group_name str

The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.

vpn_authentication_types str

A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.

azure_active_directory_authentications List[VpnServerConfigurationAzureActiveDirectoryAuthentication]

A azure_active_directory_authentication block as defined below.

client_revoked_certificates List[VpnServerConfigurationClientRevokedCertificate]

One or more client_revoked_certificate blocks as defined below.

client_root_certificates List[VpnServerConfigurationClientRootCertificate]

One or more client_root_certificate blocks as defined below.

ipsec_policy Dict[VpnServerConfigurationIpsecPolicy]

A ipsec_policy block as defined below.

location str

The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.

name str

The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.

radius_server Dict[VpnServerConfigurationRadiusServer]

A radius_server block as defined below.

tags Dict[str, str]

A mapping of tags to assign to the resource.

vpn_protocols List[str]

A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.

Outputs

All input properties are implicitly available as output properties. Additionally, the VpnServerConfiguration resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing VpnServerConfiguration Resource

Get an existing VpnServerConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VpnServerConfigurationState, opts?: CustomResourceOptions): VpnServerConfiguration
static get(resource_name, id, opts=None, azure_active_directory_authentications=None, client_revoked_certificates=None, client_root_certificates=None, ipsec_policy=None, location=None, name=None, radius_server=None, resource_group_name=None, tags=None, vpn_authentication_types=None, vpn_protocols=None, __props__=None);
func GetVpnServerConfiguration(ctx *Context, name string, id IDInput, state *VpnServerConfigurationState, opts ...ResourceOption) (*VpnServerConfiguration, error)
public static VpnServerConfiguration Get(string name, Input<string> id, VpnServerConfigurationState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AzureActiveDirectoryAuthentications List<VpnServerConfigurationAzureActiveDirectoryAuthenticationArgs>

A azure_active_directory_authentication block as defined below.

ClientRevokedCertificates List<VpnServerConfigurationClientRevokedCertificateArgs>

One or more client_revoked_certificate blocks as defined below.

ClientRootCertificates List<VpnServerConfigurationClientRootCertificateArgs>

One or more client_root_certificate blocks as defined below.

IpsecPolicy VpnServerConfigurationIpsecPolicyArgs

A ipsec_policy block as defined below.

Location string

The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.

Name string

The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.

RadiusServer VpnServerConfigurationRadiusServerArgs

A radius_server block as defined below.

ResourceGroupName string

The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

VpnAuthenticationTypes string

A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.

VpnProtocols List<string>

A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.

AzureActiveDirectoryAuthentications []VpnServerConfigurationAzureActiveDirectoryAuthentication

A azure_active_directory_authentication block as defined below.

ClientRevokedCertificates []VpnServerConfigurationClientRevokedCertificate

One or more client_revoked_certificate blocks as defined below.

ClientRootCertificates []VpnServerConfigurationClientRootCertificate

One or more client_root_certificate blocks as defined below.

IpsecPolicy VpnServerConfigurationIpsecPolicy

A ipsec_policy block as defined below.

Location string

The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.

Name string

The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.

RadiusServer VpnServerConfigurationRadiusServer

A radius_server block as defined below.

ResourceGroupName string

The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.

Tags map[string]string

A mapping of tags to assign to the resource.

VpnAuthenticationTypes string

A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.

VpnProtocols []string

A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.

azureActiveDirectoryAuthentications VpnServerConfigurationAzureActiveDirectoryAuthentication[]

A azure_active_directory_authentication block as defined below.

clientRevokedCertificates VpnServerConfigurationClientRevokedCertificate[]

One or more client_revoked_certificate blocks as defined below.

clientRootCertificates VpnServerConfigurationClientRootCertificate[]

One or more client_root_certificate blocks as defined below.

ipsecPolicy VpnServerConfigurationIpsecPolicy

A ipsec_policy block as defined below.

location string

The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.

name string

The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.

radiusServer VpnServerConfigurationRadiusServer

A radius_server block as defined below.

resourceGroupName string

The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

vpnAuthenticationTypes string

A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.

vpnProtocols string[]

A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.

azure_active_directory_authentications List[VpnServerConfigurationAzureActiveDirectoryAuthentication]

A azure_active_directory_authentication block as defined below.

client_revoked_certificates List[VpnServerConfigurationClientRevokedCertificate]

One or more client_revoked_certificate blocks as defined below.

client_root_certificates List[VpnServerConfigurationClientRootCertificate]

One or more client_root_certificate blocks as defined below.

ipsec_policy Dict[VpnServerConfigurationIpsecPolicy]

A ipsec_policy block as defined below.

location str

The Azure location where this VPN Server Configuration should be created. Changing this forces a new resource to be created.

name str

The Name which should be used for this VPN Server Configuration. Changing this forces a new resource to be created.

radius_server Dict[VpnServerConfigurationRadiusServer]

A radius_server block as defined below.

resource_group_name str

The Name of the Resource Group in which this VPN Server Configuration should be created. Changing this forces a new resource to be created.

tags Dict[str, str]

A mapping of tags to assign to the resource.

vpn_authentication_types str

A list of one of more Authentication Types applicable for this VPN Server Configuration. Possible values are AAD (Azure Active Directory), Certificate and Radius.

vpn_protocols List[str]

A list of VPN Protocols to use for this Server Configuration. Possible values are IkeV2 and OpenVPN.

Supporting Types

VpnServerConfigurationAzureActiveDirectoryAuthentication

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Audience string

The Audience which should be used for authentication.

Issuer string

The Issuer which should be used for authentication.

Tenant string

The Tenant which should be used for authentication.

Audience string

The Audience which should be used for authentication.

Issuer string

The Issuer which should be used for authentication.

Tenant string

The Tenant which should be used for authentication.

audience string

The Audience which should be used for authentication.

issuer string

The Issuer which should be used for authentication.

tenant string

The Tenant which should be used for authentication.

audience str

The Audience which should be used for authentication.

issuer str

The Issuer which should be used for authentication.

tenant str

The Tenant which should be used for authentication.

VpnServerConfigurationClientRevokedCertificate

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Name string

A name used to uniquely identify this certificate.

Thumbprint string

The Thumbprint of the Certificate.

Name string

A name used to uniquely identify this certificate.

Thumbprint string

The Thumbprint of the Certificate.

name string

A name used to uniquely identify this certificate.

thumbprint string

The Thumbprint of the Certificate.

name str

A name used to uniquely identify this certificate.

thumbprint str

The Thumbprint of the Certificate.

VpnServerConfigurationClientRootCertificate

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Name string

A name used to uniquely identify this certificate.

PublicCertData string

The Public Key Data associated with the Certificate.

Name string

A name used to uniquely identify this certificate.

PublicCertData string

The Public Key Data associated with the Certificate.

name string

A name used to uniquely identify this certificate.

publicCertData string

The Public Key Data associated with the Certificate.

name str

A name used to uniquely identify this certificate.

publicCertData str

The Public Key Data associated with the Certificate.

VpnServerConfigurationIpsecPolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

DhGroup string

The DH Group, used in IKE Phase 1. Possible values include DHGroup1, DHGroup2, DHGroup14, DHGroup24, DHGroup2048, ECP256, ECP384 and None.

IkeEncryption string

The IKE encryption algorithm, used for IKE Phase 2. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128 and GCMAES256.

IkeIntegrity string

The IKE encryption integrity algorithm, used for IKE Phase 2. Possible values include GCMAES128, GCMAES256, MD5, SHA1, SHA256 and SHA384.

IpsecEncryption string

The IPSec encryption algorithm, used for IKE phase 1. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256 and None.

IpsecIntegrity string

The IPSec integrity algorithm, used for IKE phase 1. Possible values include GCMAES128, GCMAES192, GCMAES256, MD5, SHA1 and SHA256.

PfsGroup string

The Pfs Group, used in IKE Phase 2. Possible values include ECP256, ECP384, PFS1, PFS2, PFS14, PFS24, PFS2048, PFSMM and None.

SaDataSizeKilobytes int

The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.

SaLifetimeSeconds int

The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.

DhGroup string

The DH Group, used in IKE Phase 1. Possible values include DHGroup1, DHGroup2, DHGroup14, DHGroup24, DHGroup2048, ECP256, ECP384 and None.

IkeEncryption string

The IKE encryption algorithm, used for IKE Phase 2. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128 and GCMAES256.

IkeIntegrity string

The IKE encryption integrity algorithm, used for IKE Phase 2. Possible values include GCMAES128, GCMAES256, MD5, SHA1, SHA256 and SHA384.

IpsecEncryption string

The IPSec encryption algorithm, used for IKE phase 1. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256 and None.

IpsecIntegrity string

The IPSec integrity algorithm, used for IKE phase 1. Possible values include GCMAES128, GCMAES192, GCMAES256, MD5, SHA1 and SHA256.

PfsGroup string

The Pfs Group, used in IKE Phase 2. Possible values include ECP256, ECP384, PFS1, PFS2, PFS14, PFS24, PFS2048, PFSMM and None.

SaDataSizeKilobytes int

The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.

SaLifetimeSeconds int

The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.

dhGroup string

The DH Group, used in IKE Phase 1. Possible values include DHGroup1, DHGroup2, DHGroup14, DHGroup24, DHGroup2048, ECP256, ECP384 and None.

ikeEncryption string

The IKE encryption algorithm, used for IKE Phase 2. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128 and GCMAES256.

ikeIntegrity string

The IKE encryption integrity algorithm, used for IKE Phase 2. Possible values include GCMAES128, GCMAES256, MD5, SHA1, SHA256 and SHA384.

ipsecEncryption string

The IPSec encryption algorithm, used for IKE phase 1. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256 and None.

ipsecIntegrity string

The IPSec integrity algorithm, used for IKE phase 1. Possible values include GCMAES128, GCMAES192, GCMAES256, MD5, SHA1 and SHA256.

pfsGroup string

The Pfs Group, used in IKE Phase 2. Possible values include ECP256, ECP384, PFS1, PFS2, PFS14, PFS24, PFS2048, PFSMM and None.

saDataSizeKilobytes number

The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.

saLifetimeSeconds number

The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.

dhGroup str

The DH Group, used in IKE Phase 1. Possible values include DHGroup1, DHGroup2, DHGroup14, DHGroup24, DHGroup2048, ECP256, ECP384 and None.

ikeEncryption str

The IKE encryption algorithm, used for IKE Phase 2. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128 and GCMAES256.

ikeIntegrity str

The IKE encryption integrity algorithm, used for IKE Phase 2. Possible values include GCMAES128, GCMAES256, MD5, SHA1, SHA256 and SHA384.

ipsecEncryption str

The IPSec encryption algorithm, used for IKE phase 1. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256 and None.

ipsecIntegrity str

The IPSec integrity algorithm, used for IKE phase 1. Possible values include GCMAES128, GCMAES192, GCMAES256, MD5, SHA1 and SHA256.

pfsGroup str

The Pfs Group, used in IKE Phase 2. Possible values include ECP256, ECP384, PFS1, PFS2, PFS14, PFS24, PFS2048, PFSMM and None.

saDataSizeKilobytes float

The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.

saLifetimeSeconds float

The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.

VpnServerConfigurationRadiusServer

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Address string

The Address of the Radius Server.

Secret string

The Secret used to communicate with the Radius Server.

ServerRootCertificates List<VpnServerConfigurationRadiusServerServerRootCertificateArgs>

One or more server_root_certificate blocks as defined below.

ClientRootCertificates List<VpnServerConfigurationRadiusServerClientRootCertificateArgs>

One or more client_root_certificate blocks as defined above.

Address string

The Address of the Radius Server.

Secret string

The Secret used to communicate with the Radius Server.

ServerRootCertificates []VpnServerConfigurationRadiusServerServerRootCertificate

One or more server_root_certificate blocks as defined below.

ClientRootCertificates []VpnServerConfigurationRadiusServerClientRootCertificate

One or more client_root_certificate blocks as defined above.

address string

The Address of the Radius Server.

secret string

The Secret used to communicate with the Radius Server.

serverRootCertificates VpnServerConfigurationRadiusServerServerRootCertificate[]

One or more server_root_certificate blocks as defined below.

clientRootCertificates VpnServerConfigurationRadiusServerClientRootCertificate[]

One or more client_root_certificate blocks as defined above.

address str

The Address of the Radius Server.

secret str

The Secret used to communicate with the Radius Server.

serverRootCertificates List[VpnServerConfigurationRadiusServerServerRootCertificate]

One or more server_root_certificate blocks as defined below.

client_root_certificates List[VpnServerConfigurationRadiusServerClientRootCertificate]

One or more client_root_certificate blocks as defined above.

VpnServerConfigurationRadiusServerClientRootCertificate

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Name string

A name used to uniquely identify this certificate.

Thumbprint string

The Thumbprint of the Certificate.

Name string

A name used to uniquely identify this certificate.

Thumbprint string

The Thumbprint of the Certificate.

name string

A name used to uniquely identify this certificate.

thumbprint string

The Thumbprint of the Certificate.

name str

A name used to uniquely identify this certificate.

thumbprint str

The Thumbprint of the Certificate.

VpnServerConfigurationRadiusServerServerRootCertificate

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Name string

A name used to uniquely identify this certificate.

PublicCertData string

The Public Key Data associated with the Certificate.

Name string

A name used to uniquely identify this certificate.

PublicCertData string

The Public Key Data associated with the Certificate.

name string

A name used to uniquely identify this certificate.

publicCertData string

The Public Key Data associated with the Certificate.

name str

A name used to uniquely identify this certificate.

publicCertData str

The Public Key Data associated with the Certificate.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.