共用方式為


VirtualNetworkGateways interface

Interface representing a VirtualNetworkGateways.

Methods

beginCreateOrUpdate(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)

Creates or updates a virtual network gateway in the specified resource group.

beginCreateOrUpdateAndWait(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)

Creates or updates a virtual network gateway in the specified resource group.

beginDelete(string, string, VirtualNetworkGatewaysDeleteOptionalParams)

Deletes the specified virtual network gateway.

beginDeleteAndWait(string, string, VirtualNetworkGatewaysDeleteOptionalParams)

Deletes the specified virtual network gateway.

beginDisconnectVirtualNetworkGatewayVpnConnections(string, string, P2SVpnConnectionRequest, VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams)

Disconnect vpn connections of virtual network gateway in the specified resource group.

beginDisconnectVirtualNetworkGatewayVpnConnectionsAndWait(string, string, P2SVpnConnectionRequest, VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams)

Disconnect vpn connections of virtual network gateway in the specified resource group.

beginGeneratevpnclientpackage(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)

Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.

beginGeneratevpnclientpackageAndWait(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)

Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.

beginGenerateVpnProfile(string, string, VpnClientParameters, VirtualNetworkGatewaysGenerateVpnProfileOptionalParams)

Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.

beginGenerateVpnProfileAndWait(string, string, VpnClientParameters, VirtualNetworkGatewaysGenerateVpnProfileOptionalParams)

Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.

beginGetAdvertisedRoutes(string, string, string, VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams)

This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.

beginGetAdvertisedRoutesAndWait(string, string, string, VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams)

This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.

beginGetBgpPeerStatus(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)

The GetBgpPeerStatus operation retrieves the status of all BGP peers.

beginGetBgpPeerStatusAndWait(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)

The GetBgpPeerStatus operation retrieves the status of all BGP peers.

beginGetLearnedRoutes(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)

This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.

beginGetLearnedRoutesAndWait(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)

This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.

beginGetVpnclientConnectionHealth(string, string, VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams)

Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.

beginGetVpnclientConnectionHealthAndWait(string, string, VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams)

Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.

beginGetVpnclientIpsecParameters(string, string, VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams)

The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.

beginGetVpnclientIpsecParametersAndWait(string, string, VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams)

The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.

beginGetVpnProfilePackageUrl(string, string, VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams)

Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.

beginGetVpnProfilePackageUrlAndWait(string, string, VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams)

Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.

beginReset(string, string, VirtualNetworkGatewaysResetOptionalParams)

Resets the primary of the virtual network gateway in the specified resource group.

beginResetAndWait(string, string, VirtualNetworkGatewaysResetOptionalParams)

Resets the primary of the virtual network gateway in the specified resource group.

beginResetVpnClientSharedKey(string, string, VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams)

Resets the VPN client shared key of the virtual network gateway in the specified resource group.

beginResetVpnClientSharedKeyAndWait(string, string, VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams)

Resets the VPN client shared key of the virtual network gateway in the specified resource group.

beginSetVpnclientIpsecParameters(string, string, VpnClientIPsecParameters, VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams)

The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.

beginSetVpnclientIpsecParametersAndWait(string, string, VpnClientIPsecParameters, VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams)

The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.

beginStartPacketCapture(string, string, VirtualNetworkGatewaysStartPacketCaptureOptionalParams)

Starts packet capture on virtual network gateway in the specified resource group.

beginStartPacketCaptureAndWait(string, string, VirtualNetworkGatewaysStartPacketCaptureOptionalParams)

Starts packet capture on virtual network gateway in the specified resource group.

beginStopPacketCapture(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewaysStopPacketCaptureOptionalParams)

Stops packet capture on virtual network gateway in the specified resource group.

beginStopPacketCaptureAndWait(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewaysStopPacketCaptureOptionalParams)

Stops packet capture on virtual network gateway in the specified resource group.

beginUpdateTags(string, string, TagsObject, VirtualNetworkGatewaysUpdateTagsOptionalParams)

Updates a virtual network gateway tags.

beginUpdateTagsAndWait(string, string, TagsObject, VirtualNetworkGatewaysUpdateTagsOptionalParams)

Updates a virtual network gateway tags.

get(string, string, VirtualNetworkGatewaysGetOptionalParams)

Gets the specified virtual network gateway by resource group.

list(string, VirtualNetworkGatewaysListOptionalParams)

Gets all virtual network gateways by resource group.

listConnections(string, string, VirtualNetworkGatewaysListConnectionsOptionalParams)

Gets all the connections in a virtual network gateway.

supportedVpnDevices(string, string, VirtualNetworkGatewaysSupportedVpnDevicesOptionalParams)

Gets a xml format representation for supported vpn devices.

vpnDeviceConfigurationScript(string, string, VpnDeviceScriptParameters, VirtualNetworkGatewaysVpnDeviceConfigurationScriptOptionalParams)

Gets a xml format representation for vpn device configuration script.

Method Details

beginCreateOrUpdate(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)

Creates or updates a virtual network gateway in the specified resource group.

function beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

parameters
VirtualNetworkGateway

Parameters supplied to create or update virtual network gateway operation.

options
VirtualNetworkGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>

beginCreateOrUpdateAndWait(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)

Creates or updates a virtual network gateway in the specified resource group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams): Promise<VirtualNetworkGateway>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

parameters
VirtualNetworkGateway

Parameters supplied to create or update virtual network gateway operation.

options
VirtualNetworkGatewaysCreateOrUpdateOptionalParams

The options parameters.

Returns

beginDelete(string, string, VirtualNetworkGatewaysDeleteOptionalParams)

Deletes the specified virtual network gateway.

function beginDelete(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

options
VirtualNetworkGatewaysDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, VirtualNetworkGatewaysDeleteOptionalParams)

Deletes the specified virtual network gateway.

function beginDeleteAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

options
VirtualNetworkGatewaysDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDisconnectVirtualNetworkGatewayVpnConnections(string, string, P2SVpnConnectionRequest, VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams)

Disconnect vpn connections of virtual network gateway in the specified resource group.

function beginDisconnectVirtualNetworkGatewayVpnConnections(resourceGroupName: string, virtualNetworkGatewayName: string, request: P2SVpnConnectionRequest, options?: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

request
P2SVpnConnectionRequest

The parameters are supplied to disconnect vpn connections.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDisconnectVirtualNetworkGatewayVpnConnectionsAndWait(string, string, P2SVpnConnectionRequest, VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams)

Disconnect vpn connections of virtual network gateway in the specified resource group.

function beginDisconnectVirtualNetworkGatewayVpnConnectionsAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, request: P2SVpnConnectionRequest, options?: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

request
P2SVpnConnectionRequest

The parameters are supplied to disconnect vpn connections.

Returns

Promise<void>

beginGeneratevpnclientpackage(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)

Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.

function beginGeneratevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>, VirtualNetworkGatewaysGeneratevpnclientpackageResponse>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

parameters
VpnClientParameters

Parameters supplied to the generate virtual network gateway VPN client package operation.

Returns

beginGeneratevpnclientpackageAndWait(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)

Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.

function beginGeneratevpnclientpackageAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams): Promise<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

parameters
VpnClientParameters

Parameters supplied to the generate virtual network gateway VPN client package operation.

Returns

beginGenerateVpnProfile(string, string, VpnClientParameters, VirtualNetworkGatewaysGenerateVpnProfileOptionalParams)

Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.

function beginGenerateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGenerateVpnProfileResponse>, VirtualNetworkGatewaysGenerateVpnProfileResponse>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

parameters
VpnClientParameters

Parameters supplied to the generate virtual network gateway VPN client package operation.

Returns

beginGenerateVpnProfileAndWait(string, string, VpnClientParameters, VirtualNetworkGatewaysGenerateVpnProfileOptionalParams)

Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.

function beginGenerateVpnProfileAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams): Promise<VirtualNetworkGatewaysGenerateVpnProfileResponse>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

parameters
VpnClientParameters

Parameters supplied to the generate virtual network gateway VPN client package operation.

Returns

beginGetAdvertisedRoutes(string, string, string, VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams)

This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.

function beginGetAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams): Promise<SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

peer

string

The IP address of the peer.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>

beginGetAdvertisedRoutesAndWait(string, string, string, VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams)

This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.

function beginGetAdvertisedRoutesAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams): Promise<GatewayRouteListResult>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

peer

string

The IP address of the peer.

Returns

beginGetBgpPeerStatus(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)

The GetBgpPeerStatus operation retrieves the status of all BGP peers.

function beginGetBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams): Promise<SimplePollerLike<OperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>>

beginGetBgpPeerStatusAndWait(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)

The GetBgpPeerStatus operation retrieves the status of all BGP peers.

function beginGetBgpPeerStatusAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams): Promise<BgpPeerStatusListResult>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

Returns

beginGetLearnedRoutes(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)

This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.

function beginGetLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams): Promise<SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>

beginGetLearnedRoutesAndWait(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)

This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.

function beginGetLearnedRoutesAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams): Promise<GatewayRouteListResult>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

Returns

beginGetVpnclientConnectionHealth(string, string, VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams)

Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.

function beginGetVpnclientConnectionHealth(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams): Promise<SimplePollerLike<OperationState<VpnClientConnectionHealthDetailListResult>, VpnClientConnectionHealthDetailListResult>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

Returns

beginGetVpnclientConnectionHealthAndWait(string, string, VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams)

Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.

function beginGetVpnclientConnectionHealthAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams): Promise<VpnClientConnectionHealthDetailListResult>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

Returns

beginGetVpnclientIpsecParameters(string, string, VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams)

The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.

function beginGetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams): Promise<SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The virtual network gateway name.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>

beginGetVpnclientIpsecParametersAndWait(string, string, VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams)

The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.

function beginGetVpnclientIpsecParametersAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams): Promise<VpnClientIPsecParameters>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The virtual network gateway name.

Returns

beginGetVpnProfilePackageUrl(string, string, VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams)

Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.

function beginGetVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>, VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

Returns

beginGetVpnProfilePackageUrlAndWait(string, string, VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams)

Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.

function beginGetVpnProfilePackageUrlAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams): Promise<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

Returns

beginReset(string, string, VirtualNetworkGatewaysResetOptionalParams)

Resets the primary of the virtual network gateway in the specified resource group.

function beginReset(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

options
VirtualNetworkGatewaysResetOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>

beginResetAndWait(string, string, VirtualNetworkGatewaysResetOptionalParams)

Resets the primary of the virtual network gateway in the specified resource group.

function beginResetAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams): Promise<VirtualNetworkGateway>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

options
VirtualNetworkGatewaysResetOptionalParams

The options parameters.

Returns

beginResetVpnClientSharedKey(string, string, VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams)

Resets the VPN client shared key of the virtual network gateway in the specified resource group.

function beginResetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginResetVpnClientSharedKeyAndWait(string, string, VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams)

Resets the VPN client shared key of the virtual network gateway in the specified resource group.

function beginResetVpnClientSharedKeyAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

Returns

Promise<void>

beginSetVpnclientIpsecParameters(string, string, VpnClientIPsecParameters, VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams)

The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.

function beginSetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams): Promise<SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

vpnclientIpsecParams
VpnClientIPsecParameters

Parameters supplied to the Begin Set vpnclient ipsec parameters of Virtual Network Gateway P2S client operation through Network resource provider.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>

beginSetVpnclientIpsecParametersAndWait(string, string, VpnClientIPsecParameters, VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams)

The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.

function beginSetVpnclientIpsecParametersAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams): Promise<VpnClientIPsecParameters>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

vpnclientIpsecParams
VpnClientIPsecParameters

Parameters supplied to the Begin Set vpnclient ipsec parameters of Virtual Network Gateway P2S client operation through Network resource provider.

Returns

beginStartPacketCapture(string, string, VirtualNetworkGatewaysStartPacketCaptureOptionalParams)

Starts packet capture on virtual network gateway in the specified resource group.

function beginStartPacketCapture(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysStartPacketCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStartPacketCaptureResponse>, VirtualNetworkGatewaysStartPacketCaptureResponse>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

Returns

beginStartPacketCaptureAndWait(string, string, VirtualNetworkGatewaysStartPacketCaptureOptionalParams)

Starts packet capture on virtual network gateway in the specified resource group.

function beginStartPacketCaptureAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysStartPacketCaptureOptionalParams): Promise<VirtualNetworkGatewaysStartPacketCaptureResponse>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

Returns

beginStopPacketCapture(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewaysStopPacketCaptureOptionalParams)

Stops packet capture on virtual network gateway in the specified resource group.

function beginStopPacketCapture(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewaysStopPacketCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStopPacketCaptureResponse>, VirtualNetworkGatewaysStopPacketCaptureResponse>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

parameters
VpnPacketCaptureStopParameters

Virtual network gateway packet capture parameters supplied to stop packet capture on gateway.

Returns

beginStopPacketCaptureAndWait(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewaysStopPacketCaptureOptionalParams)

Stops packet capture on virtual network gateway in the specified resource group.

function beginStopPacketCaptureAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewaysStopPacketCaptureOptionalParams): Promise<VirtualNetworkGatewaysStopPacketCaptureResponse>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

parameters
VpnPacketCaptureStopParameters

Virtual network gateway packet capture parameters supplied to stop packet capture on gateway.

Returns

beginUpdateTags(string, string, TagsObject, VirtualNetworkGatewaysUpdateTagsOptionalParams)

Updates a virtual network gateway tags.

function beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

parameters
TagsObject

Parameters supplied to update virtual network gateway tags.

options
VirtualNetworkGatewaysUpdateTagsOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>

beginUpdateTagsAndWait(string, string, TagsObject, VirtualNetworkGatewaysUpdateTagsOptionalParams)

Updates a virtual network gateway tags.

function beginUpdateTagsAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams): Promise<VirtualNetworkGateway>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

parameters
TagsObject

Parameters supplied to update virtual network gateway tags.

options
VirtualNetworkGatewaysUpdateTagsOptionalParams

The options parameters.

Returns

get(string, string, VirtualNetworkGatewaysGetOptionalParams)

Gets the specified virtual network gateway by resource group.

function get(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetOptionalParams): Promise<VirtualNetworkGateway>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

options
VirtualNetworkGatewaysGetOptionalParams

The options parameters.

Returns

list(string, VirtualNetworkGatewaysListOptionalParams)

Gets all virtual network gateways by resource group.

function list(resourceGroupName: string, options?: VirtualNetworkGatewaysListOptionalParams): PagedAsyncIterableIterator<VirtualNetworkGateway, VirtualNetworkGateway[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options
VirtualNetworkGatewaysListOptionalParams

The options parameters.

Returns

listConnections(string, string, VirtualNetworkGatewaysListConnectionsOptionalParams)

Gets all the connections in a virtual network gateway.

function listConnections(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysListConnectionsOptionalParams): PagedAsyncIterableIterator<VirtualNetworkGatewayConnectionListEntity, VirtualNetworkGatewayConnectionListEntity[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

options
VirtualNetworkGatewaysListConnectionsOptionalParams

The options parameters.

Returns

supportedVpnDevices(string, string, VirtualNetworkGatewaysSupportedVpnDevicesOptionalParams)

Gets a xml format representation for supported vpn devices.

function supportedVpnDevices(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysSupportedVpnDevicesOptionalParams): Promise<VirtualNetworkGatewaysSupportedVpnDevicesResponse>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayName

string

The name of the virtual network gateway.

Returns

vpnDeviceConfigurationScript(string, string, VpnDeviceScriptParameters, VirtualNetworkGatewaysVpnDeviceConfigurationScriptOptionalParams)

Gets a xml format representation for vpn device configuration script.

function vpnDeviceConfigurationScript(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VpnDeviceScriptParameters, options?: VirtualNetworkGatewaysVpnDeviceConfigurationScriptOptionalParams): Promise<VirtualNetworkGatewaysVpnDeviceConfigurationScriptResponse>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkGatewayConnectionName

string

The name of the virtual network gateway connection for which the configuration script is generated.

parameters
VpnDeviceScriptParameters

Parameters supplied to the generate vpn device script operation.

Returns