< Back
New-AzureRmVpnClientConfiguration
Post
NAME New-AzureRmVpnClientConfiguration
SYNOPSIS
This command allows the users to create the Vpn profile package based on pre-configured vpn settings on the VPN gateway, in addition to some
additional settings that users may need to configure, for e.g. some root certificates.
SYNTAX
New-AzureRmVpnClientConfiguration -AuthenticationMethod {EAPTLS | EAPMSCHAPv2} [-ClientRootCertificateFileList
<System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] [-Name <String>] [-ProcessorArchitecture {Amd64 |
X86}] [-RadiusRootCertificateFile <String>] -ResourceGroupName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
this allows the users to create the Vpn profile package based on pre-configured vpn settings on the VPN gateway, in addition to some additional
settings that users may need to configure, for e.g. some root certificates.
PARAMETERS
-AuthenticationMethod <String>
Authentication Method Can take values EAPMSCHAPv2 or EAPTLS. When EAPMSCHAPv2 is specified then the cmdlet generates a client configuration
installer for username/password authentication that uses EAP-MSCHAPv2 authentication protocol. If EAPTLS is specified then the cmdlet
generates a client configuration installer for certificate authentication that uses EAP-TLS protocol. The "EapTls" option can be used for both
RADIUS-based certificate authentication and certification authentication performed by the Virtual Network Gateway by uploading the trusted
root. The cmdlet automatically detects what is configured.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ClientRootCertificateFileList <System.Collections.Generic.List`1[System.String]>
A list of client root certificate paths
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
The resource name.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ProcessorArchitecture <String>
ProcessorArchitecture
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RadiusRootCertificateFile <String>
Radius server root certificate path. This is a mandatory parameter that has to be specified when EAP-TLS with RADIUS authentication is used.
This is the full path name of .cer file containing the RADIUS root certificate that the client uses to validates the RADIUS server during
authentication.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The resource group name.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSVpnProfile
NOTES
Example 1
PS C:\\> New-AzureRmVpnClientConfiguration -ResourceGroupName "ContosoResourceGroup" -Name "ContosoVirtualNetworkGateway" -AuthenticationMethod
"EAPTLS" -RadiusRootCertificateFile "C:\\Users\\Test\\Desktop\\VpnProfileRadiusCert.cer"
This cmdlet is used to create a VPN client profile zip file for "ContosoVirtualNetworkGateway" in ResourceGroup "ContosoResourceGroup". The
profile is generated for a pre-configured radius server that is configured to use "EAPTLS" authentication method with the VpnProfileRadiusCert
certificate file.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... figuration
SYNOPSIS
This command allows the users to create the Vpn profile package based on pre-configured vpn settings on the VPN gateway, in addition to some
additional settings that users may need to configure, for e.g. some root certificates.
SYNTAX
New-AzureRmVpnClientConfiguration -AuthenticationMethod {EAPTLS | EAPMSCHAPv2} [-ClientRootCertificateFileList
<System.Collections.Generic.List`1[System.String]>] [-DefaultProfile <IAzureContextContainer>] [-Name <String>] [-ProcessorArchitecture {Amd64 |
X86}] [-RadiusRootCertificateFile <String>] -ResourceGroupName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
this allows the users to create the Vpn profile package based on pre-configured vpn settings on the VPN gateway, in addition to some additional
settings that users may need to configure, for e.g. some root certificates.
PARAMETERS
-AuthenticationMethod <String>
Authentication Method Can take values EAPMSCHAPv2 or EAPTLS. When EAPMSCHAPv2 is specified then the cmdlet generates a client configuration
installer for username/password authentication that uses EAP-MSCHAPv2 authentication protocol. If EAPTLS is specified then the cmdlet
generates a client configuration installer for certificate authentication that uses EAP-TLS protocol. The "EapTls" option can be used for both
RADIUS-based certificate authentication and certification authentication performed by the Virtual Network Gateway by uploading the trusted
root. The cmdlet automatically detects what is configured.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ClientRootCertificateFileList <System.Collections.Generic.List`1[System.String]>
A list of client root certificate paths
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
The resource name.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ProcessorArchitecture <String>
ProcessorArchitecture
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RadiusRootCertificateFile <String>
Radius server root certificate path. This is a mandatory parameter that has to be specified when EAP-TLS with RADIUS authentication is used.
This is the full path name of .cer file containing the RADIUS root certificate that the client uses to validates the RADIUS server during
authentication.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The resource group name.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSVpnProfile
NOTES
Example 1
PS C:\\> New-AzureRmVpnClientConfiguration -ResourceGroupName "ContosoResourceGroup" -Name "ContosoVirtualNetworkGateway" -AuthenticationMethod
"EAPTLS" -RadiusRootCertificateFile "C:\\Users\\Test\\Desktop\\VpnProfileRadiusCert.cer"
This cmdlet is used to create a VPN client profile zip file for "ContosoVirtualNetworkGateway" in ResourceGroup "ContosoResourceGroup". The
profile is generated for a pre-configured radius server that is configured to use "EAPTLS" authentication method with the VpnProfileRadiusCert
certificate file.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... figuration