P2SVpnGatewaysOperations interface

Package:
@azure/arm-network

Interface representing a P2SVpnGateways operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginDisconnectP2SVpnConnections
beginDisconnectP2SVpnConnectionsAndWait
beginGenerateVpnProfile
beginGenerateVpnProfileAndWait
beginGetP2SVpnConnectionHealth
beginGetP2SVpnConnectionHealthAndWait
beginGetP2SVpnConnectionHealthDetailed
beginGetP2SVpnConnectionHealthDetailedAndWait
beginReset
beginResetAndWait
beginUpdateTags
beginUpdateTagsAndWait
createOrUpdate

Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.
delete

Deletes a virtual wan p2s vpn gateway.
disconnectP2SVpnConnections

Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.
generateVpnProfile

Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.
get

Retrieves the details of a virtual wan p2s vpn gateway.
getP2SVpnConnectionHealth

Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.
getP2SVpnConnectionHealthDetailed

Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.
list

Lists all the P2SVpnGateways in a subscription.
listByResourceGroup

Lists all the P2SVpnGateways in a resource group.
reset

Resets the primary of the p2s vpn gateway in the specified resource group.
updateTags

Updates virtual wan p2s vpn gateway tags.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: P2SVpnGateway, options?: P2SVpnGatewaysCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>

Property Value

(resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: P2SVpnGateway, options?: P2SVpnGatewaysCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: P2SVpnGateway, options?: P2SVpnGatewaysCreateOrUpdateOptionalParams) => Promise<P2SVpnGateway>

Property Value

(resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: P2SVpnGateway, options?: P2SVpnGatewaysCreateOrUpdateOptionalParams) => Promise<P2SVpnGateway>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysDeleteOptionalParams) => Promise<void>

beginDisconnectP2SVpnConnections

Warning

This API is now deprecated.

use disconnectP2SVpnConnections instead

beginDisconnectP2SVpnConnections: (resourceGroupName: string, p2SVpnGatewayName: string, request: P2SVpnConnectionRequest, options?: P2SVpnGatewaysDisconnectP2SVpnConnectionsOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, p2SVpnGatewayName: string, request: P2SVpnConnectionRequest, options?: P2SVpnGatewaysDisconnectP2SVpnConnectionsOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDisconnectP2SVpnConnectionsAndWait

Warning

This API is now deprecated.

use disconnectP2SVpnConnections instead

beginDisconnectP2SVpnConnectionsAndWait: (resourceGroupName: string, p2SVpnGatewayName: string, request: P2SVpnConnectionRequest, options?: P2SVpnGatewaysDisconnectP2SVpnConnectionsOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, p2SVpnGatewayName: string, request: P2SVpnConnectionRequest, options?: P2SVpnGatewaysDisconnectP2SVpnConnectionsOptionalParams) => Promise<void>

beginGenerateVpnProfile

Warning

This API is now deprecated.

use generateVpnProfile instead

beginGenerateVpnProfile: (resourceGroupName: string, gatewayName: string, parameters: P2SVpnProfileParameters, options?: P2SVpnGatewaysGenerateVpnProfileOptionalParams) => Promise<SimplePollerLike<OperationState<VpnProfileResponse>, VpnProfileResponse>>

Property Value

(resourceGroupName: string, gatewayName: string, parameters: P2SVpnProfileParameters, options?: P2SVpnGatewaysGenerateVpnProfileOptionalParams) => Promise<SimplePollerLike<OperationState<VpnProfileResponse>, VpnProfileResponse>>

beginGenerateVpnProfileAndWait

Warning

This API is now deprecated.

use generateVpnProfile instead

beginGenerateVpnProfileAndWait: (resourceGroupName: string, gatewayName: string, parameters: P2SVpnProfileParameters, options?: P2SVpnGatewaysGenerateVpnProfileOptionalParams) => Promise<VpnProfileResponse>

Property Value

(resourceGroupName: string, gatewayName: string, parameters: P2SVpnProfileParameters, options?: P2SVpnGatewaysGenerateVpnProfileOptionalParams) => Promise<VpnProfileResponse>

beginGetP2SVpnConnectionHealth

Warning

This API is now deprecated.

use getP2SVpnConnectionHealth instead

beginGetP2SVpnConnectionHealth: (resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthOptionalParams) => Promise<SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>

Property Value

(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthOptionalParams) => Promise<SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>

beginGetP2SVpnConnectionHealthAndWait

Warning

This API is now deprecated.

use getP2SVpnConnectionHealth instead

beginGetP2SVpnConnectionHealthAndWait: (resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthOptionalParams) => Promise<P2SVpnGateway>

Property Value

(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthOptionalParams) => Promise<P2SVpnGateway>

beginGetP2SVpnConnectionHealthDetailed

Warning

This API is now deprecated.

use getP2SVpnConnectionHealthDetailed instead

beginGetP2SVpnConnectionHealthDetailed: (resourceGroupName: string, gatewayName: string, request: P2SVpnConnectionHealthRequest, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthDetailedOptionalParams) => Promise<SimplePollerLike<OperationState<P2SVpnConnectionHealth>, P2SVpnConnectionHealth>>

Property Value

(resourceGroupName: string, gatewayName: string, request: P2SVpnConnectionHealthRequest, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthDetailedOptionalParams) => Promise<SimplePollerLike<OperationState<P2SVpnConnectionHealth>, P2SVpnConnectionHealth>>

beginGetP2SVpnConnectionHealthDetailedAndWait

Warning

This API is now deprecated.

use getP2SVpnConnectionHealthDetailed instead

beginGetP2SVpnConnectionHealthDetailedAndWait: (resourceGroupName: string, gatewayName: string, request: P2SVpnConnectionHealthRequest, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthDetailedOptionalParams) => Promise<P2SVpnConnectionHealth>

Property Value

(resourceGroupName: string, gatewayName: string, request: P2SVpnConnectionHealthRequest, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthDetailedOptionalParams) => Promise<P2SVpnConnectionHealth>

beginReset

Warning

This API is now deprecated.

use reset instead

beginReset: (resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysResetOptionalParams) => Promise<SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>

Property Value

(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysResetOptionalParams) => Promise<SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>

beginResetAndWait

Warning

This API is now deprecated.

use reset instead

beginResetAndWait: (resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysResetOptionalParams) => Promise<P2SVpnGateway>

Property Value

(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysResetOptionalParams) => Promise<P2SVpnGateway>

beginUpdateTags

Warning

This API is now deprecated.

use updateTags instead

beginUpdateTags: (resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: TagsObject, options?: P2SVpnGatewaysUpdateTagsOptionalParams) => Promise<SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>

Property Value

(resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: TagsObject, options?: P2SVpnGatewaysUpdateTagsOptionalParams) => Promise<SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>

beginUpdateTagsAndWait

Warning

This API is now deprecated.

use updateTags instead

beginUpdateTagsAndWait: (resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: TagsObject, options?: P2SVpnGatewaysUpdateTagsOptionalParams) => Promise<P2SVpnGateway>

Property Value

(resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: TagsObject, options?: P2SVpnGatewaysUpdateTagsOptionalParams) => Promise<P2SVpnGateway>

createOrUpdate

Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.

createOrUpdate: (resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: P2SVpnGateway, options?: P2SVpnGatewaysCreateOrUpdateOptionalParams) => PollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>

Property Value

(resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: P2SVpnGateway, options?: P2SVpnGatewaysCreateOrUpdateOptionalParams) => PollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>

delete

Deletes a virtual wan p2s vpn gateway.

delete: (resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysDeleteOptionalParams) => PollerLike<OperationState<void>, void>

disconnectP2SVpnConnections

Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.

disconnectP2SVpnConnections: (resourceGroupName: string, p2SVpnGatewayName: string, request: P2SVpnConnectionRequest, options?: P2SVpnGatewaysDisconnectP2SVpnConnectionsOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, p2SVpnGatewayName: string, request: P2SVpnConnectionRequest, options?: P2SVpnGatewaysDisconnectP2SVpnConnectionsOptionalParams) => PollerLike<OperationState<void>, void>

generateVpnProfile

Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.

generateVpnProfile: (resourceGroupName: string, gatewayName: string, parameters: P2SVpnProfileParameters, options?: P2SVpnGatewaysGenerateVpnProfileOptionalParams) => PollerLike<OperationState<VpnProfileResponse>, VpnProfileResponse>

Property Value

(resourceGroupName: string, gatewayName: string, parameters: P2SVpnProfileParameters, options?: P2SVpnGatewaysGenerateVpnProfileOptionalParams) => PollerLike<OperationState<VpnProfileResponse>, VpnProfileResponse>

get

Retrieves the details of a virtual wan p2s vpn gateway.

get: (resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysGetOptionalParams) => Promise<P2SVpnGateway>

Property Value

(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysGetOptionalParams) => Promise<P2SVpnGateway>

getP2SVpnConnectionHealth

Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

getP2SVpnConnectionHealth: (resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthOptionalParams) => PollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>

Property Value

(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthOptionalParams) => PollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>

getP2SVpnConnectionHealthDetailed

Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

getP2SVpnConnectionHealthDetailed: (resourceGroupName: string, gatewayName: string, request: P2SVpnConnectionHealthRequest, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthDetailedOptionalParams) => PollerLike<OperationState<P2SVpnConnectionHealth>, P2SVpnConnectionHealth>

Property Value

(resourceGroupName: string, gatewayName: string, request: P2SVpnConnectionHealthRequest, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthDetailedOptionalParams) => PollerLike<OperationState<P2SVpnConnectionHealth>, P2SVpnConnectionHealth>

list

Lists all the P2SVpnGateways in a subscription.

list: (options?: P2SVpnGatewaysListOptionalParams) => PagedAsyncIterableIterator<P2SVpnGateway, P2SVpnGateway[], PageSettings>

Property Value

(options?: P2SVpnGatewaysListOptionalParams) => PagedAsyncIterableIterator<P2SVpnGateway, P2SVpnGateway[], PageSettings>

listByResourceGroup

Lists all the P2SVpnGateways in a resource group.

listByResourceGroup: (resourceGroupName: string, options?: P2SVpnGatewaysListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<P2SVpnGateway, P2SVpnGateway[], PageSettings>

Property Value

(resourceGroupName: string, options?: P2SVpnGatewaysListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<P2SVpnGateway, P2SVpnGateway[], PageSettings>

reset

Resets the primary of the p2s vpn gateway in the specified resource group.

reset: (resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysResetOptionalParams) => PollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>

Property Value

(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysResetOptionalParams) => PollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>

updateTags

Updates virtual wan p2s vpn gateway tags.

updateTags: (resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: TagsObject, options?: P2SVpnGatewaysUpdateTagsOptionalParams) => PollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>

Property Value

(resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: TagsObject, options?: P2SVpnGatewaysUpdateTagsOptionalParams) => PollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>