VirtualNetworkGatewaysOperations interface
Interface representing a VirtualNetworkGateways operations.
Properties
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| create |
Creates or updates a virtual network gateway in the specified resource group. |
| delete | Deletes the specified virtual network gateway. |
| disconnect |
Disconnect vpn connections of virtual network gateway in the specified resource group. |
| generatevpnclientpackage | Generates VPN client package for P2S client of the virtual network gateway in the specified resource group. |
| generate |
Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication. |
| get | Gets the specified virtual network gateway by resource group. |
| get |
This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer. |
| get |
The GetBgpPeerStatus operation retrieves the status of all BGP peers. |
| get |
This operation retrieves the details of all the failover tests performed on the gateway for different peering locations |
| get |
This operation retrieves the details of a particular failover test performed on the gateway based on the test Guid |
| get |
This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers. |
| get |
This operation retrieves the resiliency information for an Express Route Gateway, including the gateway's current resiliency score and recommendations to further improve the score |
| get |
This operation retrieves the route set information for an Express Route Gateway based on their resiliency |
| get |
Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group. |
| get |
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. |
| get |
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. |
| invoke |
Trigger abort migration for the virtual network gateway. |
| invoke |
Trigger commit migration for the virtual network gateway. |
| invoke |
Trigger execute migration for the virtual network gateway. |
| invoke |
Trigger prepare migration for the virtual network gateway. |
| list | Gets all virtual network gateways by resource group. |
| list |
Gets all the connections in a virtual network gateway. |
| list |
List all Radius servers with respective radius secrets from virtual network gateway VpnClientConfiguration. |
| reset | Resets the primary of the virtual network gateway in the specified resource group. |
| reset |
Resets the VPN client shared key of the virtual network gateway in the specified resource group. |
| set |
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. |
| start |
This operation starts failover simulation on the gateway for the specified peering location |
| start |
Starts packet capture on virtual network gateway in the specified resource group. |
| stop |
This operation stops failover simulation on the gateway for the specified peering location |
| stop |
Stops packet capture on virtual network gateway in the specified resource group. |
| supported |
Gets a xml format representation for supported vpn devices. |
| update |
Updates a virtual network gateway tags. |
| vpn |
Gets a xml format representation for vpn device configuration script. |
Property Details
beginCreateOrUpdate
Warning
This API is now deprecated.
use createOrUpdate instead
beginCreateOrUpdate: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>
beginCreateOrUpdateAndWait
Warning
This API is now deprecated.
use createOrUpdate instead
beginCreateOrUpdateAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams) => Promise<VirtualNetworkGateway>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams) => Promise<VirtualNetworkGateway>
beginDelete
Warning
This API is now deprecated.
use delete instead
beginDelete: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait
Warning
This API is now deprecated.
use delete instead
beginDeleteAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams) => Promise<void>
beginDisconnectVirtualNetworkGatewayVpnConnections
Warning
This API is now deprecated.
use disconnectVirtualNetworkGatewayVpnConnections instead
beginDisconnectVirtualNetworkGatewayVpnConnections: (resourceGroupName: string, virtualNetworkGatewayName: string, request: P2SVpnConnectionRequest, options?: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, request: P2SVpnConnectionRequest, options?: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginDisconnectVirtualNetworkGatewayVpnConnectionsAndWait
Warning
This API is now deprecated.
use disconnectVirtualNetworkGatewayVpnConnections instead
beginDisconnectVirtualNetworkGatewayVpnConnectionsAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, request: P2SVpnConnectionRequest, options?: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, request: P2SVpnConnectionRequest, options?: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams) => Promise<void>
beginGeneratevpnclientpackage
Warning
This API is now deprecated.
use generatevpnclientpackage instead
beginGeneratevpnclientpackage: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>, VirtualNetworkGatewaysGeneratevpnclientpackageResponse>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>, VirtualNetworkGatewaysGeneratevpnclientpackageResponse>>
beginGeneratevpnclientpackageAndWait
Warning
This API is now deprecated.
use generatevpnclientpackage instead
beginGeneratevpnclientpackageAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams) => Promise<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams) => Promise<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>
beginGenerateVpnProfile
Warning
This API is now deprecated.
use generateVpnProfile instead
beginGenerateVpnProfile: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGenerateVpnProfileResponse>, VirtualNetworkGatewaysGenerateVpnProfileResponse>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGenerateVpnProfileResponse>, VirtualNetworkGatewaysGenerateVpnProfileResponse>>
beginGenerateVpnProfileAndWait
Warning
This API is now deprecated.
use generateVpnProfile instead
beginGenerateVpnProfileAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams) => Promise<VirtualNetworkGatewaysGenerateVpnProfileResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams) => Promise<VirtualNetworkGatewaysGenerateVpnProfileResponse>
beginGetAdvertisedRoutes
Warning
This API is now deprecated.
use getAdvertisedRoutes instead
beginGetAdvertisedRoutes: (resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams) => Promise<SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams) => Promise<SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>
beginGetAdvertisedRoutesAndWait
Warning
This API is now deprecated.
use getAdvertisedRoutes instead
beginGetAdvertisedRoutesAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams) => Promise<GatewayRouteListResult>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams) => Promise<GatewayRouteListResult>
beginGetBgpPeerStatus
Warning
This API is now deprecated.
use getBgpPeerStatus instead
beginGetBgpPeerStatus: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams) => Promise<SimplePollerLike<OperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams) => Promise<SimplePollerLike<OperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>>
beginGetBgpPeerStatusAndWait
Warning
This API is now deprecated.
use getBgpPeerStatus instead
beginGetBgpPeerStatusAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams) => Promise<BgpPeerStatusListResult>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams) => Promise<BgpPeerStatusListResult>
beginGetFailoverAllTestDetails
Warning
This API is now deprecated.
use getFailoverAllTestDetails instead
beginGetFailoverAllTestDetails: (resourceGroupName: string, virtualNetworkGatewayName: string, typeParam: string, fetchLatest: boolean, options?: VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteFailoverTestDetails[]>, ExpressRouteFailoverTestDetails[]>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, typeParam: string, fetchLatest: boolean, options?: VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteFailoverTestDetails[]>, ExpressRouteFailoverTestDetails[]>>
beginGetFailoverAllTestDetailsAndWait
Warning
This API is now deprecated.
use getFailoverAllTestDetails instead
beginGetFailoverAllTestDetailsAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, typeParam: string, fetchLatest: boolean, options?: VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams) => Promise<ExpressRouteFailoverTestDetails[]>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, typeParam: string, fetchLatest: boolean, options?: VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams) => Promise<ExpressRouteFailoverTestDetails[]>
beginGetFailoverSingleTestDetails
Warning
This API is now deprecated.
use getFailoverSingleTestDetails instead
beginGetFailoverSingleTestDetails: (resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, failoverTestId: string, options?: VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteFailoverSingleTestDetails[]>, ExpressRouteFailoverSingleTestDetails[]>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, failoverTestId: string, options?: VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams) => Promise<SimplePollerLike<OperationState<ExpressRouteFailoverSingleTestDetails[]>, ExpressRouteFailoverSingleTestDetails[]>>
beginGetFailoverSingleTestDetailsAndWait
Warning
This API is now deprecated.
use getFailoverSingleTestDetails instead
beginGetFailoverSingleTestDetailsAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, failoverTestId: string, options?: VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams) => Promise<ExpressRouteFailoverSingleTestDetails[]>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, failoverTestId: string, options?: VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams) => Promise<ExpressRouteFailoverSingleTestDetails[]>
beginGetLearnedRoutes
Warning
This API is now deprecated.
use getLearnedRoutes instead
beginGetLearnedRoutes: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams) => Promise<SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams) => Promise<SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>
beginGetLearnedRoutesAndWait
Warning
This API is now deprecated.
use getLearnedRoutes instead
beginGetLearnedRoutesAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams) => Promise<GatewayRouteListResult>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams) => Promise<GatewayRouteListResult>
beginGetResiliencyInformation
Warning
This API is now deprecated.
use getResiliencyInformation instead
beginGetResiliencyInformation: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetResiliencyInformationOptionalParams) => Promise<SimplePollerLike<OperationState<GatewayResiliencyInformation>, GatewayResiliencyInformation>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetResiliencyInformationOptionalParams) => Promise<SimplePollerLike<OperationState<GatewayResiliencyInformation>, GatewayResiliencyInformation>>
beginGetResiliencyInformationAndWait
Warning
This API is now deprecated.
use getResiliencyInformation instead
beginGetResiliencyInformationAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetResiliencyInformationOptionalParams) => Promise<GatewayResiliencyInformation>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetResiliencyInformationOptionalParams) => Promise<GatewayResiliencyInformation>
beginGetRoutesInformation
Warning
This API is now deprecated.
use getRoutesInformation instead
beginGetRoutesInformation: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetRoutesInformationOptionalParams) => Promise<SimplePollerLike<OperationState<GatewayRouteSetsInformation>, GatewayRouteSetsInformation>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetRoutesInformationOptionalParams) => Promise<SimplePollerLike<OperationState<GatewayRouteSetsInformation>, GatewayRouteSetsInformation>>
beginGetRoutesInformationAndWait
Warning
This API is now deprecated.
use getRoutesInformation instead
beginGetRoutesInformationAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetRoutesInformationOptionalParams) => Promise<GatewayRouteSetsInformation>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetRoutesInformationOptionalParams) => Promise<GatewayRouteSetsInformation>
beginGetVpnclientConnectionHealth
Warning
This API is now deprecated.
use getVpnclientConnectionHealth instead
beginGetVpnclientConnectionHealth: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams) => Promise<SimplePollerLike<OperationState<VpnClientConnectionHealthDetailListResult>, VpnClientConnectionHealthDetailListResult>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams) => Promise<SimplePollerLike<OperationState<VpnClientConnectionHealthDetailListResult>, VpnClientConnectionHealthDetailListResult>>
beginGetVpnclientConnectionHealthAndWait
Warning
This API is now deprecated.
use getVpnclientConnectionHealth instead
beginGetVpnclientConnectionHealthAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams) => Promise<VpnClientConnectionHealthDetailListResult>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams) => Promise<VpnClientConnectionHealthDetailListResult>
beginGetVpnclientIpsecParameters
Warning
This API is now deprecated.
use getVpnclientIpsecParameters instead
beginGetVpnclientIpsecParameters: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams) => Promise<SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams) => Promise<SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>
beginGetVpnclientIpsecParametersAndWait
Warning
This API is now deprecated.
use getVpnclientIpsecParameters instead
beginGetVpnclientIpsecParametersAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams) => Promise<VpnClientIPsecParameters>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams) => Promise<VpnClientIPsecParameters>
beginGetVpnProfilePackageUrl
Warning
This API is now deprecated.
use getVpnProfilePackageUrl instead
beginGetVpnProfilePackageUrl: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>, VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>, VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>>
beginGetVpnProfilePackageUrlAndWait
Warning
This API is now deprecated.
use getVpnProfilePackageUrl instead
beginGetVpnProfilePackageUrlAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams) => Promise<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams) => Promise<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>
beginInvokeAbortMigration
Warning
This API is now deprecated.
use invokeAbortMigration instead
beginInvokeAbortMigration: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginInvokeAbortMigrationAndWait
Warning
This API is now deprecated.
use invokeAbortMigration instead
beginInvokeAbortMigrationAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams) => Promise<void>
beginInvokeCommitMigration
Warning
This API is now deprecated.
use invokeCommitMigration instead
beginInvokeCommitMigration: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginInvokeCommitMigrationAndWait
Warning
This API is now deprecated.
use invokeCommitMigration instead
beginInvokeCommitMigrationAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams) => Promise<void>
beginInvokeExecuteMigration
Warning
This API is now deprecated.
use invokeExecuteMigration instead
beginInvokeExecuteMigration: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginInvokeExecuteMigrationAndWait
Warning
This API is now deprecated.
use invokeExecuteMigration instead
beginInvokeExecuteMigrationAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams) => Promise<void>
beginInvokePrepareMigration
Warning
This API is now deprecated.
use invokePrepareMigration instead
beginInvokePrepareMigration: (resourceGroupName: string, virtualNetworkGatewayName: string, migrationParams: VirtualNetworkGatewayMigrationParameters, options?: VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, migrationParams: VirtualNetworkGatewayMigrationParameters, options?: VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginInvokePrepareMigrationAndWait
Warning
This API is now deprecated.
use invokePrepareMigration instead
beginInvokePrepareMigrationAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, migrationParams: VirtualNetworkGatewayMigrationParameters, options?: VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, migrationParams: VirtualNetworkGatewayMigrationParameters, options?: VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams) => Promise<void>
beginReset
Warning
This API is now deprecated.
use reset instead
beginReset: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>
beginResetAndWait
Warning
This API is now deprecated.
use reset instead
beginResetAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams) => Promise<VirtualNetworkGateway>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams) => Promise<VirtualNetworkGateway>
beginResetVpnClientSharedKey
Warning
This API is now deprecated.
use resetVpnClientSharedKey instead
beginResetVpnClientSharedKey: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginResetVpnClientSharedKeyAndWait
Warning
This API is now deprecated.
use resetVpnClientSharedKey instead
beginResetVpnClientSharedKeyAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams) => Promise<void>
beginSetVpnclientIpsecParameters
Warning
This API is now deprecated.
use setVpnclientIpsecParameters instead
beginSetVpnclientIpsecParameters: (resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams) => Promise<SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams) => Promise<SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>
beginSetVpnclientIpsecParametersAndWait
Warning
This API is now deprecated.
use setVpnclientIpsecParameters instead
beginSetVpnclientIpsecParametersAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams) => Promise<VpnClientIPsecParameters>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams) => Promise<VpnClientIPsecParameters>
beginStartExpressRouteSiteFailoverSimulation
Warning
This API is now deprecated.
use startExpressRouteSiteFailoverSimulation instead
beginStartExpressRouteSiteFailoverSimulation: (resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, options?: VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, options?: VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>>
beginStartExpressRouteSiteFailoverSimulationAndWait
Warning
This API is now deprecated.
use startExpressRouteSiteFailoverSimulation instead
beginStartExpressRouteSiteFailoverSimulationAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, options?: VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams) => Promise<VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, options?: VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams) => Promise<VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>
beginStartPacketCapture
Warning
This API is now deprecated.
use startPacketCapture instead
beginStartPacketCapture: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysStartPacketCaptureOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStartPacketCaptureResponse>, VirtualNetworkGatewaysStartPacketCaptureResponse>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysStartPacketCaptureOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStartPacketCaptureResponse>, VirtualNetworkGatewaysStartPacketCaptureResponse>>
beginStartPacketCaptureAndWait
Warning
This API is now deprecated.
use startPacketCapture instead
beginStartPacketCaptureAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysStartPacketCaptureOptionalParams) => Promise<VirtualNetworkGatewaysStartPacketCaptureResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysStartPacketCaptureOptionalParams) => Promise<VirtualNetworkGatewaysStartPacketCaptureResponse>
beginStopExpressRouteSiteFailoverSimulation
Warning
This API is now deprecated.
use stopExpressRouteSiteFailoverSimulation instead
beginStopExpressRouteSiteFailoverSimulation: (resourceGroupName: string, virtualNetworkGatewayName: string, stopParameters: ExpressRouteFailoverStopApiParameters, options?: VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, stopParameters: ExpressRouteFailoverStopApiParameters, options?: VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>>
beginStopExpressRouteSiteFailoverSimulationAndWait
Warning
This API is now deprecated.
use stopExpressRouteSiteFailoverSimulation instead
beginStopExpressRouteSiteFailoverSimulationAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, stopParameters: ExpressRouteFailoverStopApiParameters, options?: VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams) => Promise<VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, stopParameters: ExpressRouteFailoverStopApiParameters, options?: VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams) => Promise<VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>
beginStopPacketCapture
Warning
This API is now deprecated.
use stopPacketCapture instead
beginStopPacketCapture: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewaysStopPacketCaptureOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStopPacketCaptureResponse>, VirtualNetworkGatewaysStopPacketCaptureResponse>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewaysStopPacketCaptureOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStopPacketCaptureResponse>, VirtualNetworkGatewaysStopPacketCaptureResponse>>
beginStopPacketCaptureAndWait
Warning
This API is now deprecated.
use stopPacketCapture instead
beginStopPacketCaptureAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewaysStopPacketCaptureOptionalParams) => Promise<VirtualNetworkGatewaysStopPacketCaptureResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewaysStopPacketCaptureOptionalParams) => Promise<VirtualNetworkGatewaysStopPacketCaptureResponse>
beginUpdateTags
Warning
This API is now deprecated.
use updateTags instead
beginUpdateTags: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams) => Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>
beginUpdateTagsAndWait
Warning
This API is now deprecated.
use updateTags instead
beginUpdateTagsAndWait: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams) => Promise<VirtualNetworkGateway>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams) => Promise<VirtualNetworkGateway>
createOrUpdate
Creates or updates a virtual network gateway in the specified resource group.
createOrUpdate: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams) => PollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams) => PollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>
delete
Deletes the specified virtual network gateway.
delete: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams) => PollerLike<OperationState<void>, void>
disconnectVirtualNetworkGatewayVpnConnections
Disconnect vpn connections of virtual network gateway in the specified resource group.
disconnectVirtualNetworkGatewayVpnConnections: (resourceGroupName: string, virtualNetworkGatewayName: string, request: P2SVpnConnectionRequest, options?: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, request: P2SVpnConnectionRequest, options?: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams) => PollerLike<OperationState<void>, void>
generatevpnclientpackage
Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.
generatevpnclientpackage: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>, VirtualNetworkGatewaysGeneratevpnclientpackageResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>, VirtualNetworkGatewaysGeneratevpnclientpackageResponse>
generateVpnProfile
Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.
generateVpnProfile: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysGenerateVpnProfileResponse>, VirtualNetworkGatewaysGenerateVpnProfileResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysGenerateVpnProfileResponse>, VirtualNetworkGatewaysGenerateVpnProfileResponse>
get
Gets the specified virtual network gateway by resource group.
get: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetOptionalParams) => Promise<VirtualNetworkGateway>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetOptionalParams) => Promise<VirtualNetworkGateway>
getAdvertisedRoutes
This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.
getAdvertisedRoutes: (resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams) => PollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams) => PollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>
getBgpPeerStatus
The GetBgpPeerStatus operation retrieves the status of all BGP peers.
getBgpPeerStatus: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams) => PollerLike<OperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams) => PollerLike<OperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>
getFailoverAllTestDetails
This operation retrieves the details of all the failover tests performed on the gateway for different peering locations
getFailoverAllTestDetails: (resourceGroupName: string, virtualNetworkGatewayName: string, typeParam: string, fetchLatest: boolean, options?: VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams) => PollerLike<OperationState<ExpressRouteFailoverTestDetails[]>, ExpressRouteFailoverTestDetails[]>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, typeParam: string, fetchLatest: boolean, options?: VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams) => PollerLike<OperationState<ExpressRouteFailoverTestDetails[]>, ExpressRouteFailoverTestDetails[]>
getFailoverSingleTestDetails
This operation retrieves the details of a particular failover test performed on the gateway based on the test Guid
getFailoverSingleTestDetails: (resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, failoverTestId: string, options?: VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams) => PollerLike<OperationState<ExpressRouteFailoverSingleTestDetails[]>, ExpressRouteFailoverSingleTestDetails[]>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, failoverTestId: string, options?: VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams) => PollerLike<OperationState<ExpressRouteFailoverSingleTestDetails[]>, ExpressRouteFailoverSingleTestDetails[]>
getLearnedRoutes
This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.
getLearnedRoutes: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams) => PollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams) => PollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>
getResiliencyInformation
This operation retrieves the resiliency information for an Express Route Gateway, including the gateway's current resiliency score and recommendations to further improve the score
getResiliencyInformation: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetResiliencyInformationOptionalParams) => PollerLike<OperationState<GatewayResiliencyInformation>, GatewayResiliencyInformation>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetResiliencyInformationOptionalParams) => PollerLike<OperationState<GatewayResiliencyInformation>, GatewayResiliencyInformation>
getRoutesInformation
This operation retrieves the route set information for an Express Route Gateway based on their resiliency
getRoutesInformation: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetRoutesInformationOptionalParams) => PollerLike<OperationState<GatewayRouteSetsInformation>, GatewayRouteSetsInformation>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetRoutesInformationOptionalParams) => PollerLike<OperationState<GatewayRouteSetsInformation>, GatewayRouteSetsInformation>
getVpnclientConnectionHealth
Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.
getVpnclientConnectionHealth: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams) => PollerLike<OperationState<VpnClientConnectionHealthDetailListResult>, VpnClientConnectionHealthDetailListResult>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams) => PollerLike<OperationState<VpnClientConnectionHealthDetailListResult>, VpnClientConnectionHealthDetailListResult>
getVpnclientIpsecParameters
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.
getVpnclientIpsecParameters: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams) => PollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams) => PollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>
getVpnProfilePackageUrl
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.
getVpnProfilePackageUrl: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>, VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>, VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>
invokeAbortMigration
Trigger abort migration for the virtual network gateway.
invokeAbortMigration: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams) => PollerLike<OperationState<void>, void>
invokeCommitMigration
Trigger commit migration for the virtual network gateway.
invokeCommitMigration: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams) => PollerLike<OperationState<void>, void>
invokeExecuteMigration
Trigger execute migration for the virtual network gateway.
invokeExecuteMigration: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams) => PollerLike<OperationState<void>, void>
invokePrepareMigration
Trigger prepare migration for the virtual network gateway.
invokePrepareMigration: (resourceGroupName: string, virtualNetworkGatewayName: string, migrationParams: VirtualNetworkGatewayMigrationParameters, options?: VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, migrationParams: VirtualNetworkGatewayMigrationParameters, options?: VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams) => PollerLike<OperationState<void>, void>
list
Gets all virtual network gateways by resource group.
list: (resourceGroupName: string, options?: VirtualNetworkGatewaysListOptionalParams) => PagedAsyncIterableIterator<VirtualNetworkGateway, VirtualNetworkGateway[], PageSettings>Property Value
(resourceGroupName: string, options?: VirtualNetworkGatewaysListOptionalParams) => PagedAsyncIterableIterator<VirtualNetworkGateway, VirtualNetworkGateway[], PageSettings>
listConnections
Gets all the connections in a virtual network gateway.
listConnections: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysListConnectionsOptionalParams) => PagedAsyncIterableIterator<VirtualNetworkGatewayConnectionListEntity, VirtualNetworkGatewayConnectionListEntity[], PageSettings>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysListConnectionsOptionalParams) => PagedAsyncIterableIterator<VirtualNetworkGatewayConnectionListEntity, VirtualNetworkGatewayConnectionListEntity[], PageSettings>
listRadiusSecrets
List all Radius servers with respective radius secrets from virtual network gateway VpnClientConfiguration.
listRadiusSecrets: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysListRadiusSecretsOptionalParams) => Promise<RadiusAuthServerListResult>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysListRadiusSecretsOptionalParams) => Promise<RadiusAuthServerListResult>
reset
Resets the primary of the virtual network gateway in the specified resource group.
reset: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams) => PollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams) => PollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>
resetVpnClientSharedKey
Resets the VPN client shared key of the virtual network gateway in the specified resource group.
resetVpnClientSharedKey: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams) => PollerLike<OperationState<void>, void>
setVpnclientIpsecParameters
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.
setVpnclientIpsecParameters: (resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams) => PollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams) => PollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>
startExpressRouteSiteFailoverSimulation
This operation starts failover simulation on the gateway for the specified peering location
startExpressRouteSiteFailoverSimulation: (resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, options?: VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, options?: VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>
startPacketCapture
Starts packet capture on virtual network gateway in the specified resource group.
startPacketCapture: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysStartPacketCaptureOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysStartPacketCaptureResponse>, VirtualNetworkGatewaysStartPacketCaptureResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysStartPacketCaptureOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysStartPacketCaptureResponse>, VirtualNetworkGatewaysStartPacketCaptureResponse>
stopExpressRouteSiteFailoverSimulation
This operation stops failover simulation on the gateway for the specified peering location
stopExpressRouteSiteFailoverSimulation: (resourceGroupName: string, virtualNetworkGatewayName: string, stopParameters: ExpressRouteFailoverStopApiParameters, options?: VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, stopParameters: ExpressRouteFailoverStopApiParameters, options?: VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>
stopPacketCapture
Stops packet capture on virtual network gateway in the specified resource group.
stopPacketCapture: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewaysStopPacketCaptureOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysStopPacketCaptureResponse>, VirtualNetworkGatewaysStopPacketCaptureResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewaysStopPacketCaptureOptionalParams) => PollerLike<OperationState<VirtualNetworkGatewaysStopPacketCaptureResponse>, VirtualNetworkGatewaysStopPacketCaptureResponse>
supportedVpnDevices
Gets a xml format representation for supported vpn devices.
supportedVpnDevices: (resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysSupportedVpnDevicesOptionalParams) => Promise<VirtualNetworkGatewaysSupportedVpnDevicesResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysSupportedVpnDevicesOptionalParams) => Promise<VirtualNetworkGatewaysSupportedVpnDevicesResponse>
updateTags
Updates a virtual network gateway tags.
updateTags: (resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams) => PollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>Property Value
(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams) => PollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>
vpnDeviceConfigurationScript
Gets a xml format representation for vpn device configuration script.
vpnDeviceConfigurationScript: (resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VpnDeviceScriptParameters, options?: VirtualNetworkGatewaysVpnDeviceConfigurationScriptOptionalParams) => Promise<VirtualNetworkGatewaysVpnDeviceConfigurationScriptResponse>Property Value
(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VpnDeviceScriptParameters, options?: VirtualNetworkGatewaysVpnDeviceConfigurationScriptOptionalParams) => Promise<VirtualNetworkGatewaysVpnDeviceConfigurationScriptResponse>