Edit

Share via

Get-AzVirtualWanVpnServerConfigurationVpnProfile

Module:
Az.Network Module

Generates and downloads Vpn profile at VirtualWan-VpnServerConfiguration level for Point to site client setup.

Syntax

ByVirtualWanNameByVpnServerConfigurationObject (Default) 

Get-AzVirtualWanVpnServerConfigurationVpnProfile
    -ResourceGroupName <String>
    -VpnServerConfiguration <PSVpnServerConfiguration>
    [-Name <String>]
    [-AuthenticationMethod <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByVirtualWanNameByVpnServerConfigurationResourceId 

Get-AzVirtualWanVpnServerConfigurationVpnProfile
    -ResourceGroupName <String>
    -VpnServerConfigurationId <String>
    [-Name <String>]
    [-AuthenticationMethod <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByVirtualWanObjectByVpnServerConfigurationObject 

Get-AzVirtualWanVpnServerConfigurationVpnProfile
    -VirtualWanObject <PSVirtualWan>
    -VpnServerConfiguration <PSVpnServerConfiguration>
    [-AuthenticationMethod <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByVirtualWanObjectByVpnServerConfigurationResourceId 

Get-AzVirtualWanVpnServerConfigurationVpnProfile
    -VirtualWanObject <PSVirtualWan>
    -VpnServerConfigurationId <String>
    [-AuthenticationMethod <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByVirtualWanResourceIdByVpnServerConfigurationObject 

Get-AzVirtualWanVpnServerConfigurationVpnProfile
    -ResourceId <String>
    -VpnServerConfiguration <PSVpnServerConfiguration>
    [-AuthenticationMethod <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByVirtualWanResourceIdByVpnServerConfigurationResourceId 

Get-AzVirtualWanVpnServerConfigurationVpnProfile
    -ResourceId <String>
    -VpnServerConfigurationId <String>
    [-AuthenticationMethod <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzVirtualWanVpnServerConfigurationVpnProfile cmdlet enables you to generate and download the Vpn profile at VirtualWan-VpnServerConfiguration level for Point to site client setup. This is required for Point to site connectivity from Point to site client to Azure P2SVpnGateway.

Examples

Example 1

Get-AzVirtualWanVpnServerConfigurationVpnProfile -Name WestUsVirtualWan -ResourceGroupName P2SCortexGATesting -VpnServerConfiguration $vpnServerConfig -AuthenticationMethod EAPTLS

ProfileUrl : https://nfvprodsuppby.blob.core.windows.net/vpnprofileimmutable/aa316f33-d0f6-4e61-994a-9aa24c0e5f70/vpnprofile/eb99aa3d-1106-49eb-9644-791c045c5cca/vpnclientconfiguration.zip?sv=2017-04-17&sr=b&sig=kZinevNqW
             qsEAbWAcYiKfUHFxZzh2hwvtb49dfVtUDA%3D&st=2019-10-25T19%3A52%3A36Z&se=2019-10-25T20%3A52%3A36Z&sp=r&fileExtension=.zip

The above command will generate and returns SAS Url for customer to download the Vpn profile at VirtualWan-VpnServerConfiguration level for Point to site client setup.

Parameters

-AuthenticationMethod

Authentication Method

Parameter properties

Type:String
Default value:None
Accepted values:EAPTLS, EAPMSCHAPv2
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The resource name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ResourceName

Parameter sets

ByVirtualWanNameByVpnServerConfigurationObject
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByVirtualWanNameByVpnServerConfigurationResourceId
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The resource group name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByVirtualWanNameByVpnServerConfigurationObject
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByVirtualWanNameByVpnServerConfigurationResourceId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceId

The Azure resource ID for the virtual wan.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:VirtualWanId

Parameter sets

ByVirtualWanResourceIdByVpnServerConfigurationObject
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ByVirtualWanResourceIdByVpnServerConfigurationResourceId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-VirtualWanObject

The virtual wan object.

Parameter properties

Type:PSVirtualWan
Default value:None
Supports wildcards:False
DontShow:False
Aliases:VirtualWan

Parameter sets

ByVirtualWanObjectByVpnServerConfigurationObject
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByVirtualWanObjectByVpnServerConfigurationResourceId
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VpnServerConfiguration

The VpnServerConfiguration with which this VirtualWan is associated.

Parameter properties

Type:PSVpnServerConfiguration
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByVirtualWanNameByVpnServerConfigurationObject
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByVirtualWanObjectByVpnServerConfigurationObject
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByVirtualWanResourceIdByVpnServerConfigurationObject
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VpnServerConfigurationId

The id of Vpn server configuration object this Virtual wan will be associated with.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByVirtualWanNameByVpnServerConfigurationResourceId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ByVirtualWanObjectByVpnServerConfigurationResourceId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ByVirtualWanResourceIdByVpnServerConfigurationResourceId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Microsoft.Azure.Commands.Network.Models.PSVirtualWan Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration

Outputs

PSVpnProfileResponse