VpnGatewaysOperations interface
Interface representing a VpnGateways operations.
Properties
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| create |
Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway. |
| delete | Deletes a virtual wan vpn gateway. |
| get | Retrieves the details of a virtual wan vpn gateway. |
| list | Lists all the VpnGateways in a subscription. |
| list |
Lists all the VpnGateways in a resource group. |
| reset | Resets the primary of the vpn gateway in the specified resource group. |
| start |
Starts packet capture on vpn gateway in the specified resource group. |
| stop |
Stops packet capture on vpn gateway in the specified resource group. |
| update |
Updates virtual wan vpn gateway tags. |
Property Details
beginCreateOrUpdate
Warning
This API is now deprecated.
use createOrUpdate instead
beginCreateOrUpdate: (resourceGroupName: string, gatewayName: string, vpnGatewayParameters: VpnGateway, options?: VpnGatewaysCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<VpnGateway>, VpnGateway>>Property Value
(resourceGroupName: string, gatewayName: string, vpnGatewayParameters: VpnGateway, options?: VpnGatewaysCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<VpnGateway>, VpnGateway>>
beginCreateOrUpdateAndWait
Warning
This API is now deprecated.
use createOrUpdate instead
beginCreateOrUpdateAndWait: (resourceGroupName: string, gatewayName: string, vpnGatewayParameters: VpnGateway, options?: VpnGatewaysCreateOrUpdateOptionalParams) => Promise<VpnGateway>Property Value
(resourceGroupName: string, gatewayName: string, vpnGatewayParameters: VpnGateway, options?: VpnGatewaysCreateOrUpdateOptionalParams) => Promise<VpnGateway>
beginDelete
Warning
This API is now deprecated.
use delete instead
beginDelete: (resourceGroupName: string, gatewayName: string, options?: VpnGatewaysDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait
Warning
This API is now deprecated.
use delete instead
beginDeleteAndWait: (resourceGroupName: string, gatewayName: string, options?: VpnGatewaysDeleteOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysDeleteOptionalParams) => Promise<void>
beginReset
Warning
This API is now deprecated.
use reset instead
beginReset: (resourceGroupName: string, gatewayName: string, options?: VpnGatewaysResetOptionalParams) => Promise<SimplePollerLike<OperationState<VpnGateway>, VpnGateway>>Property Value
(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysResetOptionalParams) => Promise<SimplePollerLike<OperationState<VpnGateway>, VpnGateway>>
beginResetAndWait
Warning
This API is now deprecated.
use reset instead
beginResetAndWait: (resourceGroupName: string, gatewayName: string, options?: VpnGatewaysResetOptionalParams) => Promise<VpnGateway>Property Value
(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysResetOptionalParams) => Promise<VpnGateway>
beginStartPacketCapture
Warning
This API is now deprecated.
use startPacketCapture instead
beginStartPacketCapture: (resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStartPacketCaptureOptionalParams) => Promise<SimplePollerLike<OperationState<VpnGatewaysStartPacketCaptureResponse>, VpnGatewaysStartPacketCaptureResponse>>Property Value
(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStartPacketCaptureOptionalParams) => Promise<SimplePollerLike<OperationState<VpnGatewaysStartPacketCaptureResponse>, VpnGatewaysStartPacketCaptureResponse>>
beginStartPacketCaptureAndWait
Warning
This API is now deprecated.
use startPacketCapture instead
beginStartPacketCaptureAndWait: (resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStartPacketCaptureOptionalParams) => Promise<VpnGatewaysStartPacketCaptureResponse>Property Value
(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStartPacketCaptureOptionalParams) => Promise<VpnGatewaysStartPacketCaptureResponse>
beginStopPacketCapture
Warning
This API is now deprecated.
use stopPacketCapture instead
beginStopPacketCapture: (resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStopPacketCaptureOptionalParams) => Promise<SimplePollerLike<OperationState<VpnGatewaysStopPacketCaptureResponse>, VpnGatewaysStopPacketCaptureResponse>>Property Value
(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStopPacketCaptureOptionalParams) => Promise<SimplePollerLike<OperationState<VpnGatewaysStopPacketCaptureResponse>, VpnGatewaysStopPacketCaptureResponse>>
beginStopPacketCaptureAndWait
Warning
This API is now deprecated.
use stopPacketCapture instead
beginStopPacketCaptureAndWait: (resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStopPacketCaptureOptionalParams) => Promise<VpnGatewaysStopPacketCaptureResponse>Property Value
(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStopPacketCaptureOptionalParams) => Promise<VpnGatewaysStopPacketCaptureResponse>
beginUpdateTags
Warning
This API is now deprecated.
use updateTags instead
beginUpdateTags: (resourceGroupName: string, gatewayName: string, vpnGatewayParameters: TagsObject, options?: VpnGatewaysUpdateTagsOptionalParams) => Promise<SimplePollerLike<OperationState<VpnGateway>, VpnGateway>>Property Value
(resourceGroupName: string, gatewayName: string, vpnGatewayParameters: TagsObject, options?: VpnGatewaysUpdateTagsOptionalParams) => Promise<SimplePollerLike<OperationState<VpnGateway>, VpnGateway>>
beginUpdateTagsAndWait
Warning
This API is now deprecated.
use updateTags instead
beginUpdateTagsAndWait: (resourceGroupName: string, gatewayName: string, vpnGatewayParameters: TagsObject, options?: VpnGatewaysUpdateTagsOptionalParams) => Promise<VpnGateway>Property Value
(resourceGroupName: string, gatewayName: string, vpnGatewayParameters: TagsObject, options?: VpnGatewaysUpdateTagsOptionalParams) => Promise<VpnGateway>
createOrUpdate
Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.
createOrUpdate: (resourceGroupName: string, gatewayName: string, vpnGatewayParameters: VpnGateway, options?: VpnGatewaysCreateOrUpdateOptionalParams) => PollerLike<OperationState<VpnGateway>, VpnGateway>Property Value
(resourceGroupName: string, gatewayName: string, vpnGatewayParameters: VpnGateway, options?: VpnGatewaysCreateOrUpdateOptionalParams) => PollerLike<OperationState<VpnGateway>, VpnGateway>
delete
Deletes a virtual wan vpn gateway.
delete: (resourceGroupName: string, gatewayName: string, options?: VpnGatewaysDeleteOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysDeleteOptionalParams) => PollerLike<OperationState<void>, void>
get
Retrieves the details of a virtual wan vpn gateway.
get: (resourceGroupName: string, gatewayName: string, options?: VpnGatewaysGetOptionalParams) => Promise<VpnGateway>Property Value
(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysGetOptionalParams) => Promise<VpnGateway>
list
Lists all the VpnGateways in a subscription.
list: (options?: VpnGatewaysListOptionalParams) => PagedAsyncIterableIterator<VpnGateway, VpnGateway[], PageSettings>Property Value
(options?: VpnGatewaysListOptionalParams) => PagedAsyncIterableIterator<VpnGateway, VpnGateway[], PageSettings>
listByResourceGroup
Lists all the VpnGateways in a resource group.
listByResourceGroup: (resourceGroupName: string, options?: VpnGatewaysListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<VpnGateway, VpnGateway[], PageSettings>Property Value
(resourceGroupName: string, options?: VpnGatewaysListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<VpnGateway, VpnGateway[], PageSettings>
reset
Resets the primary of the vpn gateway in the specified resource group.
reset: (resourceGroupName: string, gatewayName: string, options?: VpnGatewaysResetOptionalParams) => PollerLike<OperationState<VpnGateway>, VpnGateway>Property Value
(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysResetOptionalParams) => PollerLike<OperationState<VpnGateway>, VpnGateway>
startPacketCapture
Starts packet capture on vpn gateway in the specified resource group.
startPacketCapture: (resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStartPacketCaptureOptionalParams) => PollerLike<OperationState<VpnGatewaysStartPacketCaptureResponse>, VpnGatewaysStartPacketCaptureResponse>Property Value
(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStartPacketCaptureOptionalParams) => PollerLike<OperationState<VpnGatewaysStartPacketCaptureResponse>, VpnGatewaysStartPacketCaptureResponse>
stopPacketCapture
Stops packet capture on vpn gateway in the specified resource group.
stopPacketCapture: (resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStopPacketCaptureOptionalParams) => PollerLike<OperationState<VpnGatewaysStopPacketCaptureResponse>, VpnGatewaysStopPacketCaptureResponse>Property Value
(resourceGroupName: string, gatewayName: string, options?: VpnGatewaysStopPacketCaptureOptionalParams) => PollerLike<OperationState<VpnGatewaysStopPacketCaptureResponse>, VpnGatewaysStopPacketCaptureResponse>
updateTags
Updates virtual wan vpn gateway tags.
updateTags: (resourceGroupName: string, gatewayName: string, vpnGatewayParameters: TagsObject, options?: VpnGatewaysUpdateTagsOptionalParams) => PollerLike<OperationState<VpnGateway>, VpnGateway>Property Value
(resourceGroupName: string, gatewayName: string, vpnGatewayParameters: TagsObject, options?: VpnGatewaysUpdateTagsOptionalParams) => PollerLike<OperationState<VpnGateway>, VpnGateway>