Edit

Share via

Update-AzP2sVpnGateway

  • Reference
Module:
Az.Network

Update an existing P2SVpnGateway under VirtualHub for point to site connectivity.

Syntax

Update-AzP2sVpnGateway
      -ResourceGroupName <String>
      -Name <String>
      [-VpnClientAddressPool <String[]>]
      [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>]
      [-VpnGatewayScaleUnit <UInt32>]
      [-CustomDnsServer <String[]>]
      [-RoutingConfiguration <PSRoutingConfiguration>]
      [-EnableInternetSecurityFlag]
      [-DisableInternetSecurityFlag]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzP2sVpnGateway
      -ResourceGroupName <String>
      -Name <String>
      [-VpnClientAddressPool <String[]>]
      [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>]
      [-VpnServerConfiguration <PSVpnServerConfiguration>]
      [-VpnGatewayScaleUnit <UInt32>]
      [-CustomDnsServer <String[]>]
      [-RoutingConfiguration <PSRoutingConfiguration>]
      [-EnableInternetSecurityFlag]
      [-DisableInternetSecurityFlag]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzP2sVpnGateway
      -ResourceGroupName <String>
      -Name <String>
      [-VpnClientAddressPool <String[]>]
      [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>]
      -VpnServerConfigurationId <String>
      [-VpnGatewayScaleUnit <UInt32>]
      [-CustomDnsServer <String[]>]
      [-RoutingConfiguration <PSRoutingConfiguration>]
      [-EnableInternetSecurityFlag]
      [-DisableInternetSecurityFlag]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzP2sVpnGateway
      -InputObject <PSP2SVpnGateway>
      [-VpnClientAddressPool <String[]>]
      [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>]
      [-VpnGatewayScaleUnit <UInt32>]
      [-CustomDnsServer <String[]>]
      [-RoutingConfiguration <PSRoutingConfiguration>]
      [-EnableInternetSecurityFlag]
      [-DisableInternetSecurityFlag]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzP2sVpnGateway
      -InputObject <PSP2SVpnGateway>
      [-VpnClientAddressPool <String[]>]
      [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>]
      [-VpnServerConfiguration <PSVpnServerConfiguration>]
      [-VpnGatewayScaleUnit <UInt32>]
      [-CustomDnsServer <String[]>]
      [-RoutingConfiguration <PSRoutingConfiguration>]
      [-EnableInternetSecurityFlag]
      [-DisableInternetSecurityFlag]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzP2sVpnGateway
      -InputObject <PSP2SVpnGateway>
      [-VpnClientAddressPool <String[]>]
      [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>]
      -VpnServerConfigurationId <String>
      [-VpnGatewayScaleUnit <UInt32>]
      [-CustomDnsServer <String[]>]
      [-RoutingConfiguration <PSRoutingConfiguration>]
      [-EnableInternetSecurityFlag]
      [-DisableInternetSecurityFlag]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzP2sVpnGateway
      -ResourceId <String>
      [-VpnClientAddressPool <String[]>]
      [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>]
      [-VpnGatewayScaleUnit <UInt32>]
      [-CustomDnsServer <String[]>]
      [-RoutingConfiguration <PSRoutingConfiguration>]
      [-EnableInternetSecurityFlag]
      [-DisableInternetSecurityFlag]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzP2sVpnGateway
      -ResourceId <String>
      [-VpnClientAddressPool <String[]>]
      [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>]
      [-VpnServerConfiguration <PSVpnServerConfiguration>]
      [-VpnGatewayScaleUnit <UInt32>]
      [-CustomDnsServer <String[]>]
      [-RoutingConfiguration <PSRoutingConfiguration>]
      [-EnableInternetSecurityFlag]
      [-DisableInternetSecurityFlag]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzP2sVpnGateway
      -ResourceId <String>
      [-VpnClientAddressPool <String[]>]
      [-P2SConnectionConfiguration <PSP2SConnectionConfiguration[]>]
      -VpnServerConfigurationId <String>
      [-VpnGatewayScaleUnit <UInt32>]
      [-CustomDnsServer <String[]>]
      [-RoutingConfiguration <PSRoutingConfiguration>]
      [-EnableInternetSecurityFlag]
      [-DisableInternetSecurityFlag]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-AzP2sVpnGateway cmdlet enables you to update an existing P2SVpnGateway under VirtualHub with new VpnClientAddressPool or new VpnServerConfiguration or change of VpnGatewayScaleUnit.

Examples

Example 1

$vpnClientAddressSpaces = New-Object string[] 1 
$vpnClientAddressSpaces[0] = "101.10.0.0/16"
Update-AzP2sVpnGateway -ResourceGroupName P2SCortexGATesting -Name 683482ade8564515aed4b8448c9757ea-westus-gw -VpnClientAddressPool $vpnClientAddressSpaces -EnableInternetSecurityFlag

ResourceGroupName              : P2SCortexGATesting
Name                           : 683482ade8564515aed4b8448c9757ea-westus-gw
Id                             : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482ade8564515a
                                 ed4b8448c9757ea-westus-gw
Location                       : westus
VpnGatewayScaleUnit            : 1
VirtualHub                     : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/NilamdWestUsVirtualH
                                 ub
VpnServerConfiguration         : /subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/vpnServerConfigurations/NilamdWe
                                 stUsConfig
VpnServerConfigurationLocation :
VpnClientConnectionHealth      : null
Type                           : Microsoft.Network/p2sVpnGateways
ProvisioningState              : Succeeded
P2SConnectionConfigurations    : [
                                   {
                                     "ProvisioningState": "Succeeded",
                                     "VpnClientAddressPool": {
                                       "AddressPrefixes": [
                                         "101.10.0.0/16"
                                       ]
                                     },
                                     "EnableInternetSecurity": True,								 
                                     "RoutingConfiguration": {
                                       "AssociatedRouteTable": {
                                         "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable"
                                       }
                                       "PropagatedRouteTables": {
                                         "Labels": [],
                                         "Ids": [
                                           {
                                            "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/virtualHubs/WestUsVirtualHub/hubRouteTables/defaultRouteTable"
                                           }
                                        ]
                                       },
                                       "VnetRoutes": {
                                         "StaticRoutes": []
                                       }
                                     },
                                     "Name": "P2SConnectionConfigDefault",
                                     "Etag": "W/\"d7debc2f-ccbb-4f00-bddc-42c99b52fda3\"",
                                     "Id": "/subscriptions/b1f1deed-af60-4bab-9223-65d340462e24/resourceGroups/P2SCortexGATesting/providers/Microsoft.Network/p2sVpnGateways/683482
                                 ade8564515aed4b8448c9757ea-westus-gw/p2sConnectionConfigurations/P2SConnectionConfigDefault"
                                   }
                                 ]

The Update-AzP2sVpnGateway cmdlet enables you to update an existing P2SVpnGateway under VirtualHub with new VpnClientAddressPool. When Point to site client connects with this P2SVpnGateway, one of the ip address from this VpnClientAddressPool gets allocated to that client.

Example 2

Update an existing P2SVpnGateway under VirtualHub for point to site connectivity. (autogenerated)

Update-AzP2sVpnGateway -AsJob -Name 00000000-0000-0000-0000-00000000000000000-westus-gw -ResourceGroupName P2SCortexGATesting -VpnClientAddressPool <String[]> -VpnGatewayScaleUnit 1 -VpnServerConfiguration <PSVpnServerConfiguration>

Parameters

-AsJob

Run cmdlet in the background

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CustomDnsServer

The list of Custom Dns Servers.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableInternetSecurityFlag

Disable internet security flag for this P2SVpnGateway connections

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableInternetSecurityFlag

Enable internet security flag for this P2SVpnGateway connections

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

The p2s vpn gateway object to be modified

Type:PSP2SVpnGateway
Aliases:P2SVpnGateway
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The P2S vpn gateway name.

Type:String
Aliases:ResourceName, P2SVpnGatewayName, GatewayName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-P2SConnectionConfiguration

The list of P2SConnectionConfigurations that this P2SVpnGateway needs to have.

Type:PSP2SConnectionConfiguration[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The resource group name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

The Azure resource ID of the P2SVpnGateway to be modified.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-RoutingConfiguration

Routing configuration for this connection

Type:PSRoutingConfiguration
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

A hashtable which represents resource tags.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VpnClientAddressPool

P2S VpnClient AddressPool for this P2SVpnGateway P2SConnectionConfiguration.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VpnGatewayScaleUnit

The scale unit for this P2SVpnGateway.

Type:UInt32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VpnServerConfiguration

The VpnServerConfiguration to be attached to this P2SVpnGateway.

Type:PSVpnServerConfiguration
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VpnServerConfigurationId

The id of Vpn server configuration object this P2SVpnGateway will be attached to.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSP2SVpnGateway

System.String Microsoft.Azure.Commands.Network.Models.PSVpnServerConfiguration

Outputs

PSP2SVpnGateway