Update-AzVpnServerConfiguration

Module:

Az.Network Module

Updates an existing VpnServerConfiguration.

Syntax

ByVpnServerConfigurationName (Default)

Update-AzVpnServerConfiguration
    -ResourceGroupName <String>
    -Name <String>
    [-VpnProtocol <String[]>]
    [-VpnAuthenticationType <String[]>]
    [-VpnClientRootCertificateFilesList <String[]>]
    [-VpnClientRevokedCertificateFilesList <String[]>]
    [-RadiusServerAddress <String>]
    [-RadiusServerSecret <SecureString>]
    [-RadiusServerList <PSRadiusServer[]>]
    [-RadiusServerRootCertificateFilesList <String[]>]
    [-RadiusClientRootCertificateFilesList <String[]>]
    [-AadTenant <String>]
    [-AadAudience <String>]
    [-AadIssuer <String>]
    [-VpnClientIpsecPolicy <PSIpsecPolicy[]>]
    [-ConfigurationPolicyGroup <PSVpnServerConfigurationPolicyGroup[]>]
    [-Tag <Hashtable>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByVpnServerConfigurationObject

Update-AzVpnServerConfiguration
    -InputObject <PSVpnServerConfiguration>
    [-VpnProtocol <String[]>]
    [-VpnAuthenticationType <String[]>]
    [-VpnClientRootCertificateFilesList <String[]>]
    [-VpnClientRevokedCertificateFilesList <String[]>]
    [-RadiusServerAddress <String>]
    [-RadiusServerSecret <SecureString>]
    [-RadiusServerList <PSRadiusServer[]>]
    [-RadiusServerRootCertificateFilesList <String[]>]
    [-RadiusClientRootCertificateFilesList <String[]>]
    [-AadTenant <String>]
    [-AadAudience <String>]
    [-AadIssuer <String>]
    [-VpnClientIpsecPolicy <PSIpsecPolicy[]>]
    [-ConfigurationPolicyGroup <PSVpnServerConfigurationPolicyGroup[]>]
    [-Tag <Hashtable>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByVpnServerConfigurationResourceId

Update-AzVpnServerConfiguration
    -ResourceId <String>
    [-VpnProtocol <String[]>]
    [-VpnAuthenticationType <String[]>]
    [-VpnClientRootCertificateFilesList <String[]>]
    [-VpnClientRevokedCertificateFilesList <String[]>]
    [-RadiusServerAddress <String>]
    [-RadiusServerSecret <SecureString>]
    [-RadiusServerList <PSRadiusServer[]>]
    [-RadiusServerRootCertificateFilesList <String[]>]
    [-RadiusClientRootCertificateFilesList <String[]>]
    [-AadTenant <String>]
    [-AadAudience <String>]
    [-AadIssuer <String>]
    [-VpnClientIpsecPolicy <PSIpsecPolicy[]>]
    [-ConfigurationPolicyGroup <PSVpnServerConfigurationPolicyGroup[]>]
    [-Tag <Hashtable>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Update-AzVpnServerConfiguration cmdlet enables you to update the existing VpnServerConfiguration with different VpnProtocols, VpnAuthenticationTypes, IpsecPolicies and to set selected vpn authentication type related parameters as per the customer's requirement for Point to site connectivity.

Examples

Example 1

Update-AzVpnServerConfiguration -Name "test1config" -ResourceGroupName "P2SCortexGATesting" -VpnProtocol IkeV2

New-AzVpnServerConfiguration -Name "test1config" -ResourceGroupName "P2SCortexGATesting" -VpnProtocol IkeV2 -VpnAuthenticationType Certificate -VpnClientRootCertificateFilesList $listOfCerts -VpnClientRevokedCertificateFilesList $listOfCerts -Location "westus"

ResourceGroupName            : P2SCortexGATesting
Name                         : test1config
Id                           : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/test1config
Location                     : westus
VpnProtocols                 : {IkeV2}
VpnAuthenticationTypes       : {Certificate}
VpnClientRootCertificates    :
VpnClientRevokedCertificates : [
                                 {
                                   "Name": "cert2",
                                   "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F"
                                 }
                               ]
RadiusServerAddress          :
RadiusServerRootCertificates : []
RadiusClientRootCertificates : []
VpnClientIpsecPolicies       : []
AadAuthenticationParameters  : null
P2sVpnGateways               : []
Type                         : Microsoft.Network/vpnServerConfigurations
ProvisioningState            : Succeeded

The above command will update an existing VpnServerConfiguration with VpnProtocol as IkeV2.

Parameters

-AadAudience

AAD audience for P2S AAD authentication.

Parameter properties

Type:	String
Default value:	None
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

-AadIssuer

AAD issuer for P2S AAD authentication.

Parameter properties

Type:	String
Default value:	None
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

-AadTenant

AAD tenant for P2S AAD authentication.

Parameter properties

Type:	String
Default value:	None
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

-AsJob

Run cmdlet in the background

Parameter properties

Type:	SwitchParameter
Default value:	None
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

-ConfigurationPolicyGroup

The list of VpnServerConfigurationPolicyGroups that this P2SVpnGateway needs to have.

Parameter properties

Type:	PSVpnServerConfigurationPolicyGroup[]
Default value:	None
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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

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

-InputObject

The vpn server configuration object to be modified

Parameter properties

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

Parameter sets

ByVpnServerConfigurationObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
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, VpnServerConfigurationName

Parameter sets

ByVpnServerConfigurationName

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

-RadiusClientRootCertificateFilesList

A list of RadiusClientRootCertificate files' paths

Parameter properties

Type:	String[]
Default value:	None
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

-RadiusServerAddress

P2S External Radius server address.

Parameter properties

Type:	String
Default value:	None
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

-RadiusServerList

P2S External multiple radius servers.

Parameter properties

Type:	PSRadiusServer[]
Default value:	None
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

-RadiusServerRootCertificateFilesList

A list of RadiusClientRootCertificate files' paths

Parameter properties

Type:	String[]
Default value:	None
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

-RadiusServerSecret

P2S External Radius server secret.

Parameter properties

Type:	SecureString
Default value:	None
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

-ResourceGroupName

The resource group name.

Parameter properties

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

Parameter sets

ByVpnServerConfigurationName

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 vpn server configuration.

Parameter properties

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

Parameter sets

ByVpnServerConfigurationResourceId

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

-Tag

A hashtable which represents resource tags.

Parameter properties

Type:	Hashtable
Default value:	None
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

-VpnAuthenticationType

The list of P2S VPN client tunneling protocols.

Parameter properties

Type:	String[]
Default value:	None
Accepted values:	Certificate, Radius, AAD
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

-VpnClientIpsecPolicy

A list of IPSec policies for VpnServerConfiguration.

Parameter properties

Type:	PSIpsecPolicy[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

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

-VpnClientRevokedCertificateFilesList

A list of VpnClientCertificates to be revoked files' paths

Parameter properties

Type:	String[]
Default value:	None
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

-VpnClientRootCertificateFilesList

A list of VpnClientRootCertificates to be added files' paths

Parameter properties

Type:	String[]
Default value:	None
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

-VpnProtocol

The list of P2S VPN client tunneling protocols.

Parameter properties

Type:	String[]
Default value:	None
Accepted values:	IkeV2, OpenVPN
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
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

PSVpnServerConfiguration

System.String Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy[]

Outputs

PSVpnServerConfiguration