Set-AzVirtualNetworkGatewayVpnClientConfig
Sets the VPN client address pool for a virtual network gateway.
Syntax
Set-AzVirtualNetworkGatewayVpnClientConfig
-VirtualNetworkGateway <PSVirtualNetworkGateway>
-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzVirtualNetworkGatewayVpnClientConfig
-VirtualNetworkGateway <PSVirtualNetworkGateway>
-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>
-RadiusServerAddress <String>
-RadiusServerSecret <SecureString>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzVirtualNetworkVpnClientConfig cmdlet configures the client address pool for a virtual network gateway. Virtual private network (VPN) clients that connect to this gateway will be assigned an IP address from this address pool.
Examples
Example 1: Assign a VPN client address pool to a virtual network gateway
PS C:\>$Gateway = Get-AzVirtualNetworkGateway -Name "ContosoVirtualGateway"
PS C:\> Set-AzVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway $Gateway -VpnClientAddressPool "10.0.0.0/16"
This example assigns a VPN client address pool to a virtual network gateway named ContosoVirtualGateway.
The first command creates an object reference to the gateway and the object is stored in a variable named $Gateway.
The second command in the example then uses the Set-AzVirtualNetworkGatewayVpnClientConfig cmdlet to assign the address pool 10.0.0.0/16 to ContosoVirtualGateway.
Example 2: Configure external radius based authentication on existing gateway
PS C:\>$Gateway = Get-AzVirtualNetworkGateway -Name "ContosoVirtualGateway"
PS C:\> $Secure_String_Pwd = ConvertTo-SecureString "TestRadiusServerPassword" -AsPlainText -Force
PS C:\> Set-AzVirtualNetworkGatewayVpnClientConfig -VirtualNetworkGateway $Gateway -VpnClientAddressPool "10.0.0.0/16" -RadiusServerAddress "TestRadiusServer" -RadiusServerSecret $Secure_String_Pwd
This example assigns a VPN client address pool to a virtual network gateway named ContosoVirtualGateway.
The first command creates an object reference to the gateway and the object is stored in a variable named $Gateway.
The second command in the example then uses the Set-AzVirtualNetworkGatewayVpnClientConfig cmdlet to assign the address pool 10.0.0.0/16 to ContosoVirtualGateway. It also configures the external radius server "TestRadiusServer" to be used for authentication for vpn clients.
Parameters
-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 |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RadiusServerAddress
P2S External Radius server address.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-RadiusServerSecret
P2S External Radius server secret.
Type: | SecureString |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VirtualNetworkGateway
Specifies an object reference to the virtual network gateway that contains the VPN client configuration settings that this cmdlet modifies. You can create an object reference to a virtual network gateway by using the Get-AzVirtualNetworkGateway and specifying the name of the gateway.
Type: | PSVirtualNetworkGateway |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VpnClientAddressPool
Specifies the IP addresses to be assigned to clients connecting to this gateway
Type: | List<T>[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
This cmdlet accepts pipelined instances of the Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway object.
Outputs
This cmdlet modifies existing instances of the Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway object.